API Documentation Builder

Specify Output Format

"Generate Markdown API documentation"
"Create OpenAPI 3.0 specification in YAML"
"Generate both Markdown docs and OpenAPI spec"
"Create Postman collection from this API"

Customize Documentation Style

"Generate API docs in README format"
"Create comprehensive API reference with all examples"
"Generate minimal API docs (endpoints and parameters only)"

Include/Exclude Sections

"Generate API docs without rate limiting info"
"Include authentication details in the documentation"
"Add TypeScript client examples to the docs"

For Best Results

1. Add JSDoc comments: Claude uses them for descriptions 2. Use TypeScript types: Better schema generation 3. Define validation schemas: Zod, Joi, class-validator 4. Document auth requirements: Comment with @auth tags 5. Include examples in code: Sample data helps generate realistic examples 6. Group related endpoints: Organize by resource (users, posts, etc.)

Documentation Quality Checklist

Ensure generated docs include:

Keeping Docs Updated

# Regenerate after API changes
"Regenerate API documentation after recent changes"
Compare versions
"Show API changes between v1 and v2"
Generate changelog
"Create API changelog from code changes"