본문으로 건너뛰기
cccskills
무료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.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

HoangNguyen0403/agent-skills-standard

실행 점수 미검증

설치 방법 보기

포함된 파일(3)

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

SKILL.md(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

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.

리뷰

아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.

댓글

로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.

아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.

보내면 바로 공개됩니다. 이메일 주소나 전화번호 같은 개인 정보는 쓰지 마세요. URL은 2개까지입니다.

0 / 1,000자

이 양식은 reCAPTCHA로 보호되며 Google 개인정보처리방침 및 서비스 약관이 적용됩니다.

같은 저장소의 스킬

android-agp-upgrade

무료

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.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

HoangNguyen0403/agent-skills-standard5812026년 10월 24일 업데이트

android-architecture

무료

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.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

HoangNguyen0403/agent-skills-standard5812026년 10월 24일 업데이트

android-background-work

무료

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.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

HoangNguyen0403/agent-skills-standard5812026년 10월 24일 업데이트

android-compose

무료

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.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

HoangNguyen0403/agent-skills-standard5812026년 10월 24일 업데이트

android-compose-migration

무료

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.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

HoangNguyen0403/agent-skills-standard5812026년 10월 24일 업데이트

android-concurrency

무료

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.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

HoangNguyen0403/agent-skills-standard5812026년 10월 24일 업데이트

HoangNguyen0403의 스킬 모두 보기

이 스킬의 문제 신고