nestjs-swagger-docs

To document NestJS endpoints with Swagger, read the service method return type, write the 200 @ApiResponse with a schema.example including the full ApiResponseDto envelope, add non-2xx error codes, and apply shared error decorators before the method.

Standardize error responses in NestJS Swagger by applying shared error decorators as the last decorator before the method, ensuring reusability and consistent error response shapes across all documented endpoints.

Keep Swagger schema examples consistent with NestJS runtime output by validating that the documented response shapes match the actual runtime output, using schema.example within @ApiResponse decorators for accurate reflection.

Swagger API decorator order in NestJS matters for clarity and consistency. Maintain a convention by applying endpoint-specific response decorators first, followed by shared error decorators as the last decorator before the method.

To register a Swagger tag for a NestJS endpoint, verify the @ApiTags class decorator exists on the controller and ensure the tag is properly registered in the main.ts file to group endpoints correctly.

The nestjs-swagger-docs Skill enhances NestJS controller and endpoint documentation through YAML frontmatter and Markdown body, focusing on Swagger/OpenAPI annotations, error response shapes, and documentation best practices.