api-doc-generator

The API Doc Generator is a specialized agent skill designed to streamline the technical documentation process for developers and software engineers. By analyzing source code directly, it identifies API patterns, parameters, data structures, and authentication requirements, transforming them into structured, readable documentation. It is particularly useful for teams working with FastAPI, Express, or any framework that exposes API endpoints, helping maintain up-to-date specs without manual overhead.

• Automatically parses codebases to extract endpoints, HTTP methods, and request/response structures.
• Supports various API styles including REST, GraphQL, and RPC-based interfaces.
• Generates output in multiple formats: Markdown for internal documentation, OpenAPI 3.0 (Swagger) for ecosystem compatibility, and API Blueprint.
• Features a standardized template system to ensure consistency in documentation style across different projects.
• Identifies critical API metadata such as OAuth, JWT, and API Key authentication schemes.

This skill is intended for backend developers, DevOps engineers, and technical writers who need to generate documentation during the development lifecycle. To use it, simply provide the source code of the API endpoints you wish to document. The agent will analyze the logic, infer types and parameters, and provide a clear, formatted output. Ensure that your code contains clear Docstrings or type hints where possible, as these significantly improve the accuracy and richness of the generated descriptions. The output is optimized for readability, providing clear tables for path, query, and body parameters, as well as sample requests and responses. This skill is a robust tool for automating the tedious task of API specification management in CI/CD pipelines or local development workflows.