api-doc-generator

What problem does it solve?

Manually creating and maintaining API documentation, especially OpenAPI specifications, is a significant overhead for development teams. This skill automates the generation of comprehensive API documentation directly from code, ensuring accuracy and consistency.

Core Features & Use Cases

• Code-Based Documentation: Scans your codebase (routes, controllers, schemas) to extract all necessary API definition information.
• Endpoint Reference Generation: Creates structured documentation for each endpoint, including HTTP method, path, parameters, request/response bodies, and authentication requirements.
• OpenAPI Specification Output: Generates industry-standard OpenAPI (Swagger) specifications, enabling easy integration with API gateways and client SDK generation.
• Use Case: After developing new API endpoints, use this skill to generate the API documentation. It will produce both human-readable Markdown and a machine-readable OpenAPI YAML file, keeping your API docs always up-to-date.

Quick Start

Generate API documentation and an OpenAPI specification for the 'src/api/' directory.