api-documentation-generator

The API Documentation Generator skill is a specialized tool for developers, technical writers, and software engineers who need to maintain up-to-date, consistent, and high-quality API specifications. Instead of manually writing boilerplate, this skill parses your source code and logic to generate structured, human-readable documentation that adheres to industry standards. It is particularly valuable during the development lifecycle when endpoints, parameters, or authentication methods change frequently, ensuring that your documentation remains synchronized with your actual implementation.

• Automatically produces OpenAPI (Swagger) specifications for RESTful services.

• Generates comprehensive endpoint documentation including request parameters, success responses, and common error codes like 404 or 401.

• Provides multi-language SDK usage examples, including cURL commands, JavaScript fetch patterns, and Python requests snippets.

• Structures documentation with clear separation between description, requirements, and response schemas.

• Facilitates the creation of authentication guides and complex integration workflows.

• This tool expects clear API definitions in your source code; ensure that your controller or route definitions are well-structured for the best parsing results.

• Use this skill whenever you are refactoring endpoints or adding new functionality to your backend services.

• The output is optimized for Markdown viewers, making it ready for use in README files, internal wikis, or hosted developer portals.

• While the tool excels at standard CRUD operations, complex custom logic might require minor human review to ensure specific business domain context is fully captured.

• Always verify the generated JSON response schemas against your actual data contracts to maintain architectural integrity.