Api Documentation

What it does

This skill enables AI agents to generate, format, and maintain comprehensive API documentation directly from code or specifications. It transforms raw endpoint definitions into readable guides that include request/response examples, parameter descriptions, and usage instructions.

When to use it

• You need to document a new REST or GraphQL API for your development team.
• You want to convert Swagger/OpenAPI JSON files into human-readable Markdown or HTML pages.
• You are building an internal tool and require automated documentation updates as endpoints change.
• You need to create quick reference guides for external developers integrating with your service.

Key capabilities

• Parses API definitions (OpenAPI/Swagger) to extract endpoint details.
• Generates structured documentation including headers, query parameters, and body schemas.
• Creates example requests and responses in various formats (JSON, cURL).
• Supports multiple output formats like Markdown, HTML, and reStructuredText.

Example prompts

"Generate API documentation for this OpenAPI spec file: [paste_spec]" "Create a Markdown guide for the /users endpoint including authentication requirements." "Convert my Swagger JSON into a formatted README with code examples in Python and JavaScript."

Tips & gotchas

Ensure your input data (OpenAPI/Swagger specs) is valid and complete, as missing schema details will result in incomplete documentation. This skill works best when paired with version control workflows to keep docs synchronized with live API changes.