api-doc-generation

What problem does it solve?

This Skill ensures that your API documentation accurately reflects the current state of your NestJS controllers, preventing outdated or misleading information.

Core Features & Use Cases

• Automated Documentation Updates: Generates and updates API documentation directly from NestJS controller code.
• Synchronization: Keeps API documentation in sync with controller modifications, endpoint additions, and DTO changes.
• Use Case: After adding a new endpoint to the products controller, this Skill automatically updates the docs/technical/backend/api/ directory with the new endpoint's details, including parameters, responses, and authentication requirements.

Quick Start

Run the api-doc-generation skill to update the API documentation based on recent controller changes.