api-documentation
Installation
SKILL.md
API Documentation Skill
Generate clear, complete, professional API documentation from any form of API input.
Supported Input Formats
Accept any of the following as input:
- OpenAPI / Swagger (YAML or JSON, v2 or v3)
- Endpoint list (plain text, e.g.
GET /users/:id) - Route definitions (Express, FastAPI, Django, Rails, etc.)
- Controller / handler code (infer from function signatures and decorators)
- Informal descriptions ("I have an endpoint that creates a user and takes name + email")
- Postman collections (JSON)
- gRPC proto files (document as method-based API)
- GraphQL schema (document as query/mutation reference)
If the input is ambiguous, make reasonable inferences and note assumptions clearly.