create-api-docs

What problem does it solve?

This Skill automates the generation of API reference documentation, ensuring that your API documentation accurately reflects the actual code and reducing the manual effort required to keep it up-to-date.

Core Features & Use Cases

• Automated Documentation Generation: Creates API reference documents from various sources like routes, handlers, schemas, resolvers, or formal specifications.
• Endpoint Grouping: Organizes endpoints by domain, resource, or module for better readability.
• Evidence-Based Documentation: Focuses on documenting only what is explicitly evidenced in the code, marking uncertainties clearly.
• Use Case: Automatically generate a comprehensive API reference for your backend service, ensuring developers have accurate and up-to-date information on all available endpoints, their parameters, and expected responses.

Quick Start

Generate an API reference document for the current scope.