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
You can automatically extract and map every requirement from a government RFP document to your proposal sections, ensuring complete compliance coverage. The skill generates a detailed requirements-to-section matrix, identifies coverage gaps, and produces compliance checklists so you never miss a mandatory requirement in your response.
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.
You can transform complex technical ideas into structured, compelling proposals that persuade stakeholders and secure buy-in. This skill generates executive summaries, architecture diagrams, implementation roadmaps, risk assessments, and cost-benefit analyses tailored to your audience's technical sophistication. Whether you're proposing a cloud migration, system redesign, or infrastructure upgrade, you'll get a professional, comprehensive proposal ready for presentation.
You can build persuasive corporate speeches that maintain consistent brand voice, align with messaging strategy, and connect with your target audience. Whether you're addressing employees, investors, or industry conferences, Claude helps you craft compelling narratives that reinforce corporate objectives while sounding authentic and engaging.
This skill analyzes government RFPs to extract evaluation criteria, scoring weights, and compliance requirements specific to each solicitation. You'll develop data-driven proposal strategies tailored to agency priorities, assess bid/no-bid fit and win probability, and navigate the complex regulatory landscape (FAR, DFARS, NIST, etc.) to maximize contract success.
This skill analyzes RFP documents to extract compliance requirements, technical specifications, and competitive factors, then generates data-driven pricing strategies and comprehensive commercial proposals. You'll accelerate proposal turnaround time while improving compliance coverage and win rates through systematic requirement mapping, competitive positioning, and quality scoring.
Turn customer data, interviews, and metrics into conversion-focused case studies that build credibility and drive sales. You'll structure compelling narratives around measurable results, extract key insights from customer conversations, and synthesize evidence into proof points that objections can't touch. The skill handles everything from interview frameworks through multi-channel distribution, so your case studies work harder across landing pages, sales decks, and LinkedIn.
You extract critical compliance requirements from multi-region RFPs, map regulatory obligations across jurisdictions, and create actionable timelines that account for time zone differences and local approval processes. The skill identifies localization needs, coordinates stakeholder sign-offs, and ensures your proposal meets all regional requirements before submission.