Nestjs Openapi Docs

What it does

This skill automatically generates OpenAPI documentation from a NestJS application. It leverages the @nestjs/swagger decorator and configuration to produce interactive API documentation that can be used for development, testing, and public consumption. The generated documentation includes endpoint descriptions, request parameters, response models, and security schemes.

When to use it

• API Documentation: Quickly create up-to-date API documentation for your NestJS backend applications without manual effort.
• Developer Onboarding: Provide new developers with clear and concise API references to accelerate their understanding of the codebase.
• Public API Exposure: Generate a public-facing API reference for external consumers or partners.
• Automated Testing: Utilize the generated OpenAPI specification for automated testing and contract validation.

Key capabilities

• Generates OpenAPI documentation from NestJS applications.
• Utilizes @nestjs/swagger decorators for endpoint definition.
• Supports interactive Swagger UI for visualization.
• Creates a downloadable OpenAPI specification file (JSON or YAML).

Example prompts

• "Generate the OpenAPI documentation for my NestJS application."
• "Create an OpenAPI spec file in JSON format from my NestJS project."
• "Show me the Swagger UI for my API."

Tips & gotchas

• Ensure @nestjs/swagger is installed and configured correctly within your NestJS project. The skill relies on this dependency to function properly.