modbender 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:
- OpenAPI 3.0 spec — machine-readable, import into Swagger/Postman
- Markdown reference — human-readable endpoint docs with examples
- SDK quickstart — copy-paste integration guide for developers
Instructions
When the user describes API endpoints (routes, methods, parameters, responses):
- Generate a complete OpenAPI 3.0 YAML specification
- Create markdown documentation with:
- Authentication section
- Each endpoint: method, path, description, parameters table, request/response examples
- Error codes reference
- Rate limiting notes
- 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.