Api Reference Writer
Transform code into comprehensive API reference documentation with tables and SDK examples
What You Can Do
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.
Features
Auto-generates descriptions, HTTP methods, URLs, and authentication requirements for each endpoint
Creates organized tables with parameter names, types, constraints, default values, and descriptions
Produces realistic JSON, XML, and form-encoded examples showing actual API payloads
Lists HTTP status codes, error types, causes, and developer-friendly resolution guidance
Generates usage examples in Python, JavaScript, Go, Java, Ruby, PHP, and cURL
Converts data models into formatted field definitions with types, validation rules, and relationships
Documents API limits, throttling policies, and best practices for handling rate limiting
Explains API key, OAuth 2.0, JWT, or custom auth schemes with implementation examples
Example Output
Example 1: REST Endpoint Documentation
## GET /api/v1/users/{id}
Retrieve a single user by ID.
### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | string | Yes | The unique user identifier |
| include_profile | boolean | No | Include extended profile data (default: false) |
### Request
```bash
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.example.com/api/v1/users/usr_12345?include_profile=true
Response
{
"id": "usr_12345",
"email": "user@example.com",
"status": "active",
"created_at": "2024-01-15T10:30:00Z"
}
Error Codes
| Code | Message | Cause |
|---|---|---|
| 404 | User not found | The user ID does not exist |
| 401 | Unauthorized | Missing or invalid API key |
**Example 2: Python SDK Snippet**
```python
from example_sdk import Client
client = Client(api_key="sk_live_...")
user = client.users.get("usr_12345", include_profile=True)
print(user.email)
What's Included
- api-reference-writer SKILL.md: Core instruction file with system prompt and generation guidelines
- API Documentation Template: Markdown template structure for endpoints, parameters, examples, and errors
- OpenAPI to Markdown Converter: Framework for transforming OpenAPI 3.0/Swagger specs into reference docs
- SDK Snippet Templates: Multi-language code templates (Python, JavaScript, Go, Java, Ruby, PHP, cURL)
- Error Code Catalog Checklist: Standard HTTP statuses and API-specific error codes to document
Who It's For
- Backend engineers and API developers documenting REST, GraphQL, or WebSocket APIs
- Technical writers creating developer-facing API reference materials
- DevOps/platform engineers maintaining internal API documentation and SDKs
- Open-source maintainers generating API docs from code repositories
- Developer advocates preparing API documentation for external integrations
Best For
- Generating complete API reference documentation from OpenAPI/Swagger specs
- Creating parameter tables and request/response examples from production code
- Producing multi-language SDK code snippets and usage examples
- Documenting error codes, status codes, and troubleshooting guides
- Building searchable, machine-readable API documentation for client generation tools
You might also like
You'll develop systematic approaches to injectable formulation design, from API selection through sterilization strategy. Claude helps you troubleshoot failed batches by analyzing root causes, recommends regulatory pathways (505(b)(2), ANDA, NDA), and provides science-backed solutions for stability, compatibility, and manufacturability challenges.
This skill helps you systematically assess integration needs across your systems, design architecture patterns that scale with your organization, and identify technical and operational risks before implementation. You'll receive architecture recommendations aligned to your business constraints, clear integration roadmaps, and risk mitigation strategies that reduce deployment surprises. Get structured decision records suitable for architecture review boards and engineering teams.
Claude analyzes your code diffs and generates standardized commit messages that follow the Conventional Commits specification. The skill automatically determines the correct commit type, scope, and description based on the changes you've made, ensuring your messages are parseable by automation tools while remaining human-readable for code reviewers.
You can transform raw text into structured, labeled datasets for machine learning, analysis, and research. This skill performs named entity recognition, sentiment classification, part-of-speech tagging, and dependency parsing—generating consistent, validated annotations at scale. Use it to prepare corpora, extract entities, classify documents, or perform linguistic analysis without manual annotation.
This skill helps you systematically analyze service mesh architectures, identify inter-service communication failures, and design optimal routing and security policies. You'll receive step-by-step troubleshooting guidance tailored to your mesh platform (Istio, Linkerd, Consul), configuration validation reports, and architectural recommendations that reduce latency, improve observability, and tighten security posture.
This skill automates the creation of production-ready deployment validation checklists, infrastructure-as-code templates, and incident response runbooks tailored to your ML stack. You get comprehensive pre-deployment checks covering model validation, data pipeline integrity, infrastructure readiness, and monitoring setup—all customized for your specific models and cloud provider. The skill generates executable runbooks that teams can follow during incidents, including rollback procedures, failover strategies, and diagnostic commands.
Build scalable internal developer platform architectures that reduce cognitive load and standardize workflows for your development organization. Document golden paths that guide developers through common tasks like onboarding, deployment, and troubleshooting. Map platform capabilities, integrations, and service topology to align with your engineering scale and technical strategy.
Rapidly analyze firmware logs and diagnose hardware issues that cause device failures, connectivity problems, and performance degradation. You'll identify root causes from stack traces, crash dumps, and sensor data, then generate specific optimization recommendations. This skill transforms raw device logs into actionable debugging plans that reduce time-to-resolution from hours to minutes.