Skip to content
cccskills
FreePublished on GitHub

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.

The English summary is being prepared. Showing the original description.

Run score Not tested

See how to install

Files included (3)

  • SKILL.md2.1 KB
  • evals/evals.json2.2 KB
  • references/example.md639 B

SKILL.md (original)

Review the instructions the agent will receive before you install.

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 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.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Upgrade an Android project to Android Gradle Plugin (AGP) 9. Use when migrating to AGP 9, updating Gradle build files, migrating to built-in Kotlin, or adopting the new AGP DSL.

The English summary is being prepared. Showing the original description.

HoangNguyen0403/agent-skills-standard582Updated Oct 25, 2026

Apply Clean Architecture layering, modularization, and Unidirectional Data Flow in Android projects. Use when setting up project structure, placing code in layers, configuring feature/core modules, or implementing UDF patterns; defer Compose state and ViewModel/StateFlow implementation to their specific skills.

The English summary is being prepared. Showing the original description.

HoangNguyen0403/agent-skills-standard582Updated Oct 25, 2026

Implement WorkManager and background processing correctly on Android. Use when creating Worker classes, scheduling tasks, choosing between WorkManager and Foreground Services, or setting up Hilt in workers; defer FCM and notification delivery to android-notifications.

The English summary is being prepared. Showing the original description.

HoangNguyen0403/agent-skills-standard582Updated Oct 25, 2026

Build high-performance declarative UI with Jetpack Compose. Use when writing Composable functions, optimizing recomposition, hoisting state, or working with LazyColumn and side effects; defer deep-link and navigation routing to android-navigation.

The English summary is being prepared. Showing the original description.

HoangNguyen0403/agent-skills-standard582Updated Oct 25, 2026

Migrate an Android XML View to Jetpack Compose following a structured 10-step workflow. Use when converting XML layouts to Compose, setting up Compose in an existing View-based project, or incrementally adopting Compose.

The English summary is being prepared. Showing the original description.

HoangNguyen0403/agent-skills-standard582Updated Oct 25, 2026

Write correct coroutine scopes, lifecycle collection, and dispatcher injection in Android production code. Use for suspend functions, coroutine scopes, and dispatcher mechanics; defer ViewModel StateFlow/LiveData architecture, Fragment lifecycle recipes, persistence/notifications, and unit-test recipes to their specific skills.

The English summary is being prepared. Showing the original description.

HoangNguyen0403/agent-skills-standard582Updated Oct 25, 2026

See all skills by HoangNguyen0403

Report a problem with this skill