Doc Api
Generate comprehensive API documentation from code with interactive examples and testing capabilities
$ npx claude-code-templates@latest --command="documentation/doc-api" --yesRequires Claude Code. The command adds this command to your project's .claudedirectory — nothing runs on ToolZip's servers.
What's inside this command
Component source
API Documentation Generator
Generate API documentation from code: $ARGUMENTS
Current API Context
- API endpoints: !
find . -name "route" -o -name "controller" -o -name "api" | head -5 - API specs: !
find . -name "openapi" -o -name "swagger" -o -name "*.graphql" | head -3 - Server framework: @package.json or detect from imports
- Existing docs: @docs/api/ or @api-docs/ (if exists)
- Test files: !
find . -name "test" -path "/api/" | head -3
Task
Generate comprehensive API documentation with interactive features: $ARGUMENTS
- Code Analysis and Discovery
- Identify REST APIs, GraphQL schemas, and RPC services
- Map out controller classes, route definitions, and middleware
- Discover request/response models and data structures
- Documentation Tool Selection
- OpenAPI/Swagger: REST APIs with interactive documentation
- GraphQL: GraphiQL, GraphQL Playground, or Apollo Studio
- Postman: API collections and documentation
- Insomnia: API design and documentation
- Redoc: Alternative OpenAPI renderer
- API Blueprint: Markdown-based API documentation
- API Specification Generation
For REST APIs with OpenAPI:
openapi: 3.0.0
info:
title: $ARGUMENTS API
version: 1.0.0
description: Comprehensive API for $ARGUMENTS
servers:
- url: https://api.example.com/v1
paths:
/users:
get:
summary: List users
parameters:
- name: page
in: query
schema:
type: integer
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
components:
schemas:
User:
type: object
properties:
id:
type: integer
name:
type: string
email:
type: string- Endpoint Documentation
- Specify request parameters (path, query, header, body)
- Define response schemas and status codes
- Include error responses and error codes
- Document authentication and authorization requirements
- Request/Response Examples
- Include sample response data with proper formatting
- Show different response scenarios (success, error, edge cases)
- Document content types and encoding
- Authentication Documentation
- Explain authorization scopes and permissions
- Provide authentication examples and token formats
- Document session management and refresh token flows
- Data Model Documentation
- Document field types, constraints, and validation rules
- Include relationships between entities
- Provide example data structures
- Error Handling Documentation
- Explain error codes and their meanings
- Provide troubleshooting guidance
- Include rate limiting and throttling information
- Interactive Documentation Setup
Swagger UI Integration:
<!DOCTYPE html>
<html>
<head>
<title>API Documentation</title>
<link rel="stylesheet" type="text/css" href="./swagger-ui-bundle.css" />
</head>
<body>
<div id="swagger-ui"></div>
</body>
</html>- Code Annotation and Comments
- Use framework-specific annotation tools:
- Java: @ApiOperation, @ApiParam (Swagger annotations)
- Python: Docstrings with FastAPI or Flask-RESTX
- Node.js: JSDoc comments with swagger-jsdoc
- C#: XML documentation comments
- Automated Documentation Generation
For Node.js/Express:
const swaggerJsdoc = require('swagger-jsdoc');
const swaggerUi = require('swagger-ui-express');
const options = {
definition: {
openapi: '3.0.0',
info: {
title: 'API Documentation',
version: '1.0.0',
},
},
apis: ['./routes/*.js'],
};
const specs = swaggerJsdoc(options);
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs));- Testing Integration
- Include test scripts and validation rules
- Set up automated API testing
- Document test scenarios and expected outcomes
- Version Management
- Maintain documentation for multiple API versions
- Document deprecation timelines and migration guides
- Track breaking changes between versions
- Performance Documentation
- Include performance benchmarks and SLAs
- Document caching strategies and headers
- Explain pagination and filtering options
- SDK and Client Library Documentation
- Document SDK usage and examples
- Provide quickstart guides for different languages
- Include integration examples and best practices
- Environment-Specific Documentation
- Include environment-specific endpoints and configurations
- Document deployment and configuration requirements
- Provide environment setup instructions
- Security Documentation
- Include CORS and CSP policies
- Document input validation and sanitization
- Explain security headers and their purposes
- Maintenance and Updates
- Create processes for keeping documentation current
- Review and validate documentation regularly
- Integrate documentation reviews into development workflow
Framework-Specific Examples: FastAPI (Python):from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI(title="My API", version="1.0.0")
class User(BaseModel):
id: int
name: str
email: str
@app.get("/users/{user_id}", response_model=User)
async def get_user(user_id: int):
"""Get a user by ID."""
return {"id": user_id, "name": "John", "email": "john@example.com"}@RestController
@Api(tags = "Users")
public class UserController {
@GetMapping("/users/{id}")
@ApiOperation(value = "Get user by ID")
public ResponseEntity<User> getUser(
@PathVariable @ApiParam("User ID") Long id) {
// Implementation
}
}Remember to keep documentation up-to-date with code changes and make it easily accessible to both internal teams and external consumers.
Related Claude Code Commands
Create Architecture Documentation
Generate comprehensive architecture documentation with diagrams, ADRs, and interactive visualization
Update Docs
Systematically update project documentation with implementation status, API changes, and synchronized content
Generate Api Documentation
Auto-generate API reference documentation with multiple output formats and automated deployment
Docs Maintenance
Use PROACTIVELY to implement comprehensive documentation maintenance systems with quality assurance, validation, and automated updates
Create Onboarding Guide
Create comprehensive developer onboarding guide with environment setup, workflows, and interactive tutorials
Troubleshooting Guide
Generate systematic troubleshooting documentation with diagnostic procedures, common issues, and automated solutions
Catalog data and component content are sourced from the open-source davila7/claude-code-templates project (MIT license). ToolZip curates the listing and writes original descriptions; every component links back to its original source. Claude Code is a product of Anthropic. ToolZip is an independent catalog and is not affiliated with or endorsed by Anthropic.