api-documentation
Installation
SKILL.md
What I do
- Guide discovery and extraction of API surfaces from code (REST, GraphQL, gRPC, WebSocket, SDKs)
- Define documentation structure for endpoints, authentication, parameters, responses, and errors
- Provide OpenAPI 3.0 and Markdown format conventions
- Enforce pagination, filtering, rate limiting, error codes, and changelog standards
When to use me
Use when generating API documentation from code, standardizing format across services, or reviewing docs for completeness.
Key Rules
Discovery Phase
Analyze the codebase for:
- REST: Route definitions, HTTP methods/paths, request/response schemas, auth, query/path/body params, status codes, rate limiting, pagination
- GraphQL: Schema definitions (types, queries, mutations, subscriptions), resolvers, input types, validation, auth directives
- gRPC: Service definitions, message types, streaming patterns
- WebSocket: Event names, message schemas, connection lifecycle
- SDKs: Public classes and methods, function signatures, configuration options