api-documentation-generator

This API documentation generator is a specialized skill designed for software engineers and technical writers who need to maintain up-to-date, machine-readable, and human-friendly API references. By analyzing your codebase, this agent automates the tedious process of writing endpoint descriptions, parameter definitions, and response schemas, ensuring consistency across your entire project documentation. It is an essential tool for teams adopting API-first development workflows or those needing to bridge the gap between backend implementation and frontend integration.

• Automatically generates OpenAPI and Swagger 2.0/3.0 specifications from controller code, routes, and model definitions.

• Creates standardized endpoint documentation including path parameters, query strings, headers, and request bodies.

• Provides structured response examples including successful (200 OK) outputs and common error scenarios (404, 401, 500, etc.).

• Generates ready-to-use SDK usage examples in multiple languages including cURL, JavaScript (Fetch), and Python (Requests).

• Produces comprehensive integration and authentication guides based on security protocols defined in your application.

• Facilitates the creation of error code reference tables and status code explanations.

• Input Requirements: This skill performs best when provided with source code repositories, controller files, or specific route definitions as context.

• Integration: It is highly effective when triggered via slash commands within an interactive session, especially after modifying backend logic.

• Best Practices: Use this during the PR review process to ensure documentation keeps pace with feature development. The generated output follows a strict Markdown structure that can be directly pasted into wikis, README files, or dedicated documentation portals.

• Constraints: The accuracy of the documentation depends on the clarity of the source code. It is recommended to use this tool alongside descriptive JSDoc or Python docstrings to maximize the quality of generated endpoint descriptions.