OpenAPI & Documentation

Priority: P2 (MAINTENANCE)

Workflow

1. Enable Swagger plugin in nest-cli.json to auto-generate @ApiProperty from DTOs.
2. Annotate controllers with @ApiTags, @ApiResponse, and auth decorators.
3. Create generic wrappers for paginated and polymorphic responses.
4. Generate separate docs for public vs internal audiences.

Setup

See implementation examples for nest-cli.json plugin config and Swagger bootstrap.

Response Documentation

• Strictness: Every controller method must @ApiResponse({ status: 200, type: UserDto }).
• Generic Wrappers: Define ApiPaginatedResponse<T> decorators using ApiExtraModels + getSchemaPath() to handle generics properly.