api-documenter

The API Documenter skill automates the generation of API documentation directly from code and comments. It solves the problem of maintaining up-to-date API documentation, especially when API endpoints are frequently added or modified. Developers no longer need to manually write or update documentation every time the API changes, saving both time and effort while ensuring consistency and accuracy in the documentation.

This skill can automatically generate OpenAPI/Swagger specifications for a variety of frameworks, including Express.js, FastAPI, Django REST, Spring Boot, Gin, and Rails. It supports multiple formats such as OpenAPI 3.0 (JSON/YAML), Swagger 2.0, API Blueprint, and RAML. Additionally, it extracts essential information such as endpoint descriptions, request/response schemas, authentication requirements, and error responses, all of which are included in the generated documentation. The tool is triggered by changes to API-related files, such as route files, controller files, or any mention of API documentation requests.

This skill is highly useful for backend developers, DevOps teams, and technical writers who need to keep API documentation up to date in fast-moving projects. It ensures that the documentation evolves alongside the codebase, reducing human errors and improving collaboration across development teams. Ideal users include teams working with microservices, RESTful APIs, or GraphQL, where keeping documentation accurate and current is critical.