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 get Claude to analyze your API specifications and automatically generate bulletproof parameter validation logic. Claude creates security-hardened middleware, enforces type constraints, detects malicious input patterns, and generates comprehensive error handling — all tailored to your framework and existing codebase. The result is production-ready validation code with zero unvalidated inputs reaching your business logic.
This skill enables you to automatically audit your websites against compliance standards and detect deviations from expected baselines. You can track regulatory requirements, identify policy violations, and generate compliance reports with actionable remediation steps. Monitor multiple sites simultaneously and maintain detailed audit trails for compliance documentation.
Transform schema and data changes into production-ready migration packages that protect data integrity and minimize downtime. You can handle column additions, renames, type conversions, and backfills using proven patterns like expand-contract and shadow tables. The skill generates explicit rollback scripts, validation checklists, and phased execution plans that keep applications stable throughout the migration.
You'll transform high-level feature requirements into a complete development plan covering API design, frontend implementation, testing strategy, and documentation. The skill helps you identify dependencies, parallelize work across frontend and backend teams, and establish quality gates that ensure features ship bug-free with proper error handling and logging.
You can conduct comprehensive toxicology safety assessments, generate regulatory-compliant safety documentation, and produce detailed hazard analyses for pharmaceutical and chemical submissions. This skill structures toxicological data into standardized safety reports, maps findings to regulatory guidelines (FDA, EMA, ICH), and identifies risk characterization strategies to support regulatory submissions and approval timelines.
You can submit your Solidity smart contracts for comprehensive security analysis, vulnerability detection, and gas optimization recommendations. Claude reviews your code against known attack vectors, design patterns, and best practices—identifying reentrancy risks, overflow/underflow issues, access control flaws, and inefficient operations. You receive actionable fix recommendations with explanations of the security implications and gas savings potential.
You can design end-to-end NGS pipelines tailored to your experiment type (WGS, WES, RNA-seq, targeted), troubleshoot pipeline failures by analyzing QC metrics and logs, and optimize performance by fine-tuning parameters and identifying bottlenecks. This skill handles the full workflow from raw sequencing data quality assessment through variant interpretation and annotation.
You can accelerate your entire antenna design workflow—from initial concept to optimized specifications—by leveraging Claude's knowledge of electromagnetic theory, antenna types, and design trade-offs. Claude helps you parameterize designs, identify optimal configurations for your frequency band and application, and prepare detailed briefs for simulation and manufacturing. You'll generate design reviews, impedance-matching solutions, and validation checklists without context-switching to multiple tools.