generate-api-doc

What problem does it solve?

This Skill automates the creation of comprehensive API reference documentation directly from your codebase, saving developers significant time and ensuring accuracy.

Core Features & Use Cases

• Automated Endpoint Discovery: Scans code to find all API routes and their associated handlers.
• Detailed Parameter & Schema Analysis: Extracts request/response details, including path/query parameters, headers, and body schemas.
• Authentication & Validation Documentation: Identifies and documents authentication requirements and validation rules.
• Example Generation: Creates realistic example requests and responses.
• Use Case: After implementing a new set of API endpoints in your backend framework (e.g., Express, FastAPI), use this Skill to instantly generate a Markdown or OpenAPI specification for your API documentation.

Quick Start

Use the generate-api-doc skill to create markdown documentation for all API endpoints in the project and save it to 'api-docs.md'.