API Documentation Architect
Transform scattered API specs into polished, developer-friendly documentation
What You Can Do
You can generate comprehensive API documentation from code, OpenAPI/Swagger specs, or detailed descriptions. This skill creates well-structured docs with clear endpoints, authentication flows, error handling, and practical code examples. It turns technical specifications into documentation that developers actually want to read, reducing support requests and onboarding time.
Features
Converts your API definitions into organized endpoint specs with parameters, request/response examples, and status codes
Generates working code samples in multiple languages (JavaScript, Python, cURL, etc.) for every endpoint
Produces clear setup instructions for API keys, OAuth, JWT tokens, and other auth methods with troubleshooting steps
Creates typed client libraries that mirror your API structure, making integration easier for developers
Plans backward-compatible API versions and migration guides to help users upgrade smoothly
Organizes endpoints by resource type and use case, creating quick-lookup tables and category indices
Documents all error codes with explanations, causes, and resolution steps for faster developer troubleshooting
Example Output
Example 1: Endpoint Documentation
## GET /api/users/{id}
Retrieve a single user by ID.
### Parameters
- `id` (string, required): The unique user identifier
- `include` (string, optional): Related data to include (profile, settings)
### Response
```json
{
"id": "usr_123",
"name": "Jane Doe",
"email": "jane@example.com",
"created_at": "2024-01-15T10:30:00Z"
}
Example Request (cURL)
curl -X GET "https://api.example.com/api/users/usr_123" \
-H "Authorization: Bearer token_abc123"
### Example 2: Authentication Guide
**Bearer Token Authentication** — Include your API key in the Authorization header:
```bash
Authorization: Bearer YOUR_API_KEY
Common issues: Expired tokens return 401 Unauthorized. Rotate keys quarterly for security.
Example 3: Error Reference
Error 422 - Validation Failed — Request contains invalid data. Check field types and required fields. Solution: Review error details in response and correct malformed fields.
What's Included
- Complete endpoint reference: Fully documented HTTP methods, paths, parameters, responses, and status codes for every API endpoint
- Code examples library: Working examples in JavaScript, Python, cURL, and other popular languages you choose
- Authentication & security guide: Setup instructions for API keys, OAuth flows, scopes, and best practices for secure API usage
- Error handling reference: Catalog of all error codes with descriptions, causes, and troubleshooting steps
- Quick-start tutorial: Step-by-step guide for new developers to authenticate, make their first request, and handle responses
Who It's For
- Backend engineers and API developers
- Technical writers and developer advocates
- DevOps and platform teams
- Product managers overseeing integrations
- Startup founders building APIs
Best For
- Building documentation from existing APIs
- Designing new API specifications
- Creating developer onboarding materials
- Standardizing documentation across microservices
- Maintaining versioned API guides
You might also like
You conduct rigorous retirement income adequacy analyses that evaluate whether a client's projected retirement assets will sustain their desired lifestyle across realistic market conditions, inflation trajectories, and longevity scenarios. The skill structures three-pronged analysis: deterministic baseline scenarios, stochastic modeling with sequence-of-returns analysis, and contingency planning with decision triggers. You translate complex probability distributions into comprehensible client language while maintaining analytical rigor for compliance documentation and fiduciary defense.
by soniqo
You can convert raw API code, OpenAPI specs, GraphQL schemas, and implementation details into production-ready reference documentation. The skill generates systematically organized endpoint documentation with parameter tables, real request/response examples, error code catalogs, authentication details, rate limits, and SDK usage snippets in multiple programming languages—creating the authoritative developer reference for REST APIs, GraphQL APIs, WebSocket APIs, and webhook schemas.
