api-documentation-generator

Point the Skill at your API codebase and it analyzes routes, HTTP methods, parameters, and response schemas to produce structured documentation. Output includes endpoint references, authentication guides, and code examples in cURL, JavaScript, and Python.

Complete REST API docs include endpoint URLs and methods, request parameters with types and validation rules, success and error responses with status codes, authentication requirements, and working code examples. Rate limits and pagination patterns should also be documented.

Yes, the Skill can produce OpenAPI 3.0 YAML specifications and Postman collections alongside Markdown documentation. These artifacts enable interactive documentation and automated API testing workflows.

Yes, the Skill covers REST, GraphQL, and WebSocket APIs. For GraphQL it documents queries, mutations, variables, and typed error responses; for WebSocket APIs it documents events and message formats.

Generate docs from code comments or annotations, add API tests that validate documented behavior, and review documentation with every API change. Treating docs as part of the code review process prevents drift.

Generated documentation requires human review for environment-specific details, business context, and accuracy of examples. It should not replace testing, validation, or expert review before publishing to external developers.