api-documenter

What problem does it solve?

This Skill eliminates the tedious and error-prone process of manually writing and updating API documentation. It ensures your API specifications are always in sync with your codebase, saving developers time and reducing inconsistencies.

Core Features & Use Cases

• Auto-Generate OpenAPI Specs: Automatically creates OpenAPI 3.0 (Swagger) specifications from your code and comments.
• Multi-Framework Support: Works with popular frameworks like Express.js, FastAPI, Django REST, Spring Boot, Gin, and Rails.
• Use Case: As you add new API endpoints or modify existing ones in your Express.js application, this skill automatically updates your openapi.json file, ready for integration with Swagger UI or Postman.

Quick Start

The skill activates automatically when API files change.

Write an API endpoint with JSDoc comments:

/**

• Get user by ID
• @param {string} id - User ID / app.get('/api/users/:id', async (req, res) => { / ... */ });

The skill will then generate or update your OpenAPI spec.