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
Analyze Solidity and other smart contract code for security vulnerabilities, gas inefficiencies, and best practice violations. Get detailed reports with risk scoring, remediation suggestions, and optimization recommendations. Whether you're auditing before deployment or reviewing third-party contracts, this skill identifies critical issues faster than manual review.
You can systematically diagnose database performance bottlenecks by sharing your schema, slow query logs, and execution plans with Claude. It identifies root causes—missing indexes, inefficient joins, lock contention—and provides prioritized recommendations with ready-to-implement SQL. Skip the manual log analysis and get tuning strategies tailored to your workload.
This skill provides a structured approach to analyzing process problems, identifying root causes, and recommending capacity optimizations. You'll get clear bottleneck identification, data-driven recommendations, and a framework to validate whether your solutions actually work. Perfect for diagnosing why workflows are slow and finding the leverage points that matter most.
Use Claude to systematically analyze your database queries, execution plans, and schema to identify performance bottlenecks. The skill generates actionable optimization recommendations with SQL rewrites, index strategies, and configuration tuning. You'll receive detailed before-and-after performance analysis to validate improvements and prioritize work by impact.
This skill evaluates your research protocols against institutional review board requirements, identifies compliance gaps, and generates the documentation needed for IRB submission. You receive a detailed assessment report, risk analysis, and ready-to-use documentation templates tailored to your specific research design.
Conduct organized security assessments using Claude as your strategic partner. You'll develop comprehensive test plans, identify vulnerabilities through systematic reconnaissance, document findings with professional rigor, and map security gaps to compliance frameworks. Claude helps you maintain audit trails, prioritize risks by business impact, and generate executive reports.
You'll design and implement mobile features with architectural rigor, cross-platform considerations, and edge-case handling built-in. This skill generates complete system designs, platform-specific implementation strategies, performance optimization approaches, and testing frameworks. The output is production-ready guidance spanning iOS and Android with security, offline resilience, and deployment strategies included.
You can architect multi-node ROS control systems from scratch, including node design patterns, communication flows, and real-time constraints. You'll debug complex node interactions using publisher/subscriber analysis, service call tracing, and action server diagnostics. You can optimize motion controllers through PID tuning, trajectory planning validation, and performance profiling to achieve precise, responsive robotic behavior.