🎁 Get the FREE AI Skills Starter Guide β€” Subscribe β†’
BytesAgainBytesAgain
BytesAgain β€Ί Skills β€Ί API Documentation Generator
πŸ¦€ ClawHub

API Documentation Generator

by @1kalin

Generate comprehensive OpenAPI 3.0 specs, markdown reference docs, and SDK quickstarts from API endpoint descriptions with examples and error codes.

Versionv1.0.0
Downloads1,362
#clawhub
TERMINAL
clawhub install afrexai-api-docs

πŸ“– About This Skill

API Documentation Generator

Generate production-ready API documentation from endpoint descriptions. Outputs OpenAPI 3.0, markdown reference docs, and SDK quickstart guides.

Usage

Describe your API endpoints and this skill generates:

1. OpenAPI 3.0 spec β€” machine-readable, import into Swagger/Postman 2. Markdown reference β€” human-readable endpoint docs with examples 3. SDK quickstart β€” copy-paste integration guide for developers

Instructions

When the user describes API endpoints (routes, methods, parameters, responses):

1. Generate a complete OpenAPI 3.0 YAML specification 2. Create markdown documentation with: - Authentication section - Each endpoint: method, path, description, parameters table, request/response examples - Error codes reference - Rate limiting notes 3. Generate a quickstart guide with curl examples and common language snippets (Python, JavaScript, Go)

Output Format

# openapi.yaml β€” full OpenAPI 3.0 spec


# API Reference β€” human-readable docs


# Quickstart Guide β€” integration examples

Quality Standards

  • Every endpoint must have request AND response examples
  • Use realistic sample data, not "string" or "example"
  • Include error responses (400, 401, 403, 404, 500)
  • Document pagination, filtering, and sorting patterns
  • Note breaking changes and versioning strategy

    • Tips

  • Paste your route files or controller code for automatic extraction
  • Works with REST, GraphQL (schema-first), and gRPC (proto-first)
  • Combine with CI/CD to auto-generate docs on every deploy

    • Built by AfrexAI β€” AI-powered business tools for teams that ship fast.

    πŸ’‘ Examples

    Describe your API endpoints and this skill generates:

    1. OpenAPI 3.0 spec β€” machine-readable, import into Swagger/Postman 2. Markdown reference β€” human-readable endpoint docs with examples 3. SDK quickstart β€” copy-paste integration guide for developers

    πŸ“‹ Tips & Best Practices

  • Paste your route files or controller code for automatic extraction
  • Works with REST, GraphQL (schema-first), and gRPC (proto-first)
  • Combine with CI/CD to auto-generate docs on every deploy

    • Built by AfrexAI β€” AI-powered business tools for teams that ship fast.