API Documentation Generator & Refiner
Generate fully-formatted API documentation with examples, error guides, and version tracking
What You Can Do
This skill transforms raw API specifications into production-ready documentation. You provide endpoint schemas, request/response examples, and error conditions—Claude generates comprehensive docs with consistent formatting, complete error guides, and versioning annotations. Output is immediately usable in your API reference or developer portal.
Features
Parse OpenAPI 3.0 and Swagger 2.0 specs to automatically generate endpoint documentation with zero manual formatting
Apply unified templates across all endpoints, parameters, and examples for professional, searchable documentation
Generate error code tables with HTTP status codes, descriptions, causes, and client-side solutions
Annotate changes between API versions, highlight breaking changes, and create migration guides
Create realistic, working examples in multiple languages (cURL, Python, JavaScript, Go)
Build searchable tables for all request parameters, query strings, headers, and response fields
Generate step-by-step OAuth2, API Key, JWT, and mutual TLS authentication documentation
Create clear rate limit policies, quota documentation, and guidance on handling 429 responses
Example Output
Sample Generated Documentation
POST /api/v1/messages
Send a message to a user.
Authorization: Bearer token required
Request Body:
{
"recipient_id": "user_123",
"content": "Hello world",
"priority": "normal"
}
Response (201 Created):
{
"id": "msg_456",
"status": "sent",
"timestamp": "2026-08-01T14:30:00Z"
}
Error Reference
| Error Code | HTTP Status | Meaning | Solution |
|---|---|---|---|
| INVALID_RECIPIENT | 400 | Recipient user not found | Check recipient_id exists |
| RATE_LIMITED | 429 | Too many requests | Wait 60 seconds before retrying |
| AUTH_REQUIRED | 401 | Missing authorization header | Add Authorization: Bearer YOUR_TOKEN |
Version Compatibility Matrix
| Feature | v1.0 | v2.0 | v2.1 |
|---|---|---|---|
| Messages API | ✓ | ✓ | ✓ |
| Message Threading | ✗ | ✓ | ✓ |
| Read Receipts | ✗ | ✗ | ✓ |
| Breaking Changes | — | Required auth header | — |
What's Included
- OpenAPI/Swagger spec parser: Analyze and extract endpoint definitions, schemas, and metadata from spec files
- Markdown documentation templates: Pre-built templates for endpoint docs, error guides, and authentication flows
- Error code reference generator: Transform error definitions into searchable reference tables with solutions
- Version compatibility builder: Create matrices showing which features exist in which API versions
- Example request/response formatter: Generate working code examples in multiple programming languages
- Authentication guide templates: Pre-written guides for OAuth2, API Keys, JWT, and other auth methods
Who It's For
- Backend API developers
- Technical documentation writers
- DevOps and platform engineers
- API product managers
- Solutions architects
Best For
- Documenting REST API endpoints
- Creating OpenAPI/Swagger documentation
- Building API reference guides
- Generating error handling documentation
- Managing API versioning documentation
You might also like
Convert your unstructured research notes into professionally structured white papers using strategic prompting patterns. This skill extracts key arguments from raw content, organizes them into compelling sections, and applies editorial polish that emphasizes authority and clarity. You'll produce publication-ready documents that move your audience to action.
You'll generate complete, production-ready keynote speeches tailored to your audience, complete with speaker notes, timing cues, and impact optimization strategies. Each speech balances narrative storytelling with data-driven insights, includes pacing guidelines for optimal delivery impact, and provides specific guidance on emphasis, pauses, and audience engagement moments.
You provide your API specification (OpenAPI, Swagger, AsyncAPI, or raw specification), and this skill generates comprehensive, production-ready documentation including code examples, tutorials, integration guides, and troubleshooting sections. It transforms technical specifications into accessible developer guides that accelerate onboarding and reduce support questions.
You can draft, refine, and strategize corporate communications that resonate with different stakeholder groups while maintaining consistent brand voice. This skill helps you create audience-specific versions of key messages, develop crisis communication frameworks, and ensure all communications align with corporate policy and brand guidelines. Whether you're managing internal change communications, media relations, or stakeholder updates, you get structured guidance for professional, on-brand messaging.
This skill transforms raw customer success data into compelling, multi-format B2B case studies that drive conversions. You provide customer context and business outcomes, and it structures a persuasive narrative, extracts key metrics, generates targeted variations for different buyer personas, and produces formats for web, PDF, and social channels. It includes buyer journey mapping and messaging frameworks so your case study works across your entire sales and marketing funnel.
Transform hardware specifications, datasheets, and engineering data into clear, structured technical documentation tailored to different audiences. This skill automatically identifies safety requirements, ensures regulatory compliance, and generates audience-specific variants—from detailed technical manuals to user-friendly guides—reducing documentation time and improving accuracy.
This skill guides you through structuring, writing, and refining keynote speeches with proven narrative frameworks and storytelling techniques. You'll develop speeches that resonate emotionally, maintain strategic focus, and deliver measurable impact with your audience. From outline to final delivery-ready draft, you get structured feedback on flow, pacing, and authenticity.
Generate complete keynote speeches structured for live delivery with precise timing cues, pacing calculations, and personalized voice calibration. You'll get a word-for-word manuscript annotated with delivery markers, audience engagement moments, and a persuasive call-to-action that lands. Claude handles story structure, messaging hierarchy, and rhetorical flow so you can focus on authentic delivery.