How do I install the Nestjs Documentation skill?

Run npx skillmds@latest add hoangnguyen0403/nestjs-documentation in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Nestjs Documentation safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. Capability flags: reads secrets. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Nestjs Documentation?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Nestjs Documentation free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Nestjs Documentation?

HoangNguyen0403 (@hoangnguyen0403) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Nestjs Documentation by hoangnguyen0403

Name: Nestjs Documentation
Rating: 4.2 (5 reviews)
Author: HoangNguyen0403

Nestjs Documentation

Automate Swagger/OpenAPI documentation and standardize API response schemas in NestJS. Use when generating OpenAPI specs, documenting paginated or generic responses, configuring the Nest CLI Swagger plugin, or publishing versioned API docs.

HoangNguyen0403 Updated Sep 9, 2026 542 repo stars

File contents

OpenAPI & Documentation

Priority: P2 (MEDIUM)

Workflow

Enable Swagger plugin in nest-cli.json to auto-generate @ApiProperty from DTOs.
Annotate controllers with @ApiTags, @ApiResponse, and auth decorators.
Create generic wrappers for paginated and polymorphic responses.
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.

Advanced Patterns

Polymorphism: Use @ApiExtraModels and getSchemaPath for oneOf/anyOf union types.
File Uploads: Use @ApiConsumes('multipart/form-data') with explicit @ApiBody schema.
Authentication: Use @ApiBearerAuth() or @ApiSecurity('api-key') matching DocumentBuilder config.
Enums: Force named enums: @ApiProperty({ enum: MyEnum, enumName: 'MyEnum' }).

Operation Grouping

Tags: Mandatory @ApiTags('domains') on every Controller.
Multiple Docs: Generate separate docs for different audiences (Public vs Internal).

See implementation examples

Anti-Patterns

No missing @ApiResponse: Every controller method must declare its response type and status code.
No /docs in production: Disable Swagger in production to prevent API schema exposure.
No manual @ApiProperty everywhere: Use Nest CLI Swagger plugin to auto-generate from DTOs.

---name: nestjs-documentationdescription: Automate Swagger/OpenAPI documentation and standardize API response schemas in NestJS. Use when generating OpenAPI specs, documenting paginated or generic responses, configuring the Nest CLI Swagger plugin, or publishing versioned API docs.---# OpenAPI & Documentation ## **Priority: P2 (MEDIUM)** ## 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](references/example.md) 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. ## Advanced Patterns - **Polymorphism**: Use `@ApiExtraModels` and `getSchemaPath` for `oneOf`/`anyOf` union types. - **File Uploads**: Use `@ApiConsumes('multipart/form-data')` with explicit `@ApiBody` schema. - **Authentication**: Use `@ApiBearerAuth()` or `@ApiSecurity('api-key')` matching `DocumentBuilder` config. - **Enums**: Force named enums: `@ApiProperty({ enum: MyEnum, enumName: 'MyEnum' })`. ## Operation Grouping - **Tags**: Mandatory `@ApiTags('domains')` on every Controller. - **Multiple Docs**: Generate separate docs for different audiences (Public vs Internal). See [implementation examples](references/example.md) ## Anti-Patterns - **No missing @ApiResponse**: Every controller method must declare its response type and status code. - **No /docs in production**: Disable Swagger in production to prevent API schema exposure. - **No manual @ApiProperty everywhere**: Use Nest CLI Swagger plugin to auto-generate from DTOs.

Frequently asked questions