nestjs-documentation
/nestjs-documentation
Automatyzuje dokumentację Swagger/OpenAPI w NestJS i standaryzuje schematy odpowiedzi, w tym stronicowane i generyczne, z wtyczką Nest CLI i wersjonowanymi dokumentami API.
- Autor
- HoangNguyen0403 ↗
- Repozytorium
- agent-skills-standard ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 22.10.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 3
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 22.10.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
Co robi i kiedy
Automatyzuje dokumentację Swagger/OpenAPI w NestJS i standaryzuje schematy odpowiedzi, w tym stronicowane i generyczne, z wtyczką Nest CLI i wersjonowanymi dokumentami API.
Oryginalny opis (EN)
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.
Jak działa
- Priority: P2 (MEDIUM)
- Workflow
- Setup
- Response Documentation
- Advanced Patterns
- Operation Grouping
- Anti-Patterns
Podgląd SKILL.md
---
name: nestjs-documentation
description: 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.
metadata:
triggers:
files:
- 'main.ts'
- '**/*.dto.ts'
keywords:
- DocumentBuilder
- SwaggerModule
- ApiProperty
- ApiResponse
---
# 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.
Pliki w paczce (3)
- SKILL.md 2 KB
- evals/evals.json 2 KB
- references/example.md 1 KB
Wersje
W bazie nie ma innych skilli o nazwie nestjs-documentation.
Migawka bazy z 13.11.2026 · wersja paczki 3cc2ce17d3f8 (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 95api-documentation-generator
Generuje specyfikacje OpenAPI i Swagger oraz dokumentację API z kodu albo projektu. - 90backend-openapi-documentation
Dokumentuje API metodą spec-first w OpenAPI 3.x, z generowaniem kodu i wersjonowanymi specyfikacjami. - 100api-documentation
Tworzy dokumentację API dla programistów: REST, schematy GraphQL i metody SDK, w tym OpenAPI, Swagger, interaktywne dokumenty i przykłady. - 100api-documenting
Generuje dokumentację API z kodu: referencja API, dokumentacja endpointów i specyfikacje OpenAPI lub Swagger. - 100openapi-expert
Wspiera projektowanie API, dokumentację i generowanie kodu ze specyfikacji OpenAPI i Swagger, w tym webhooki i polimorfizm. - 100swagger
Wyjaśnia dodanie dokumentacji Swagger i OpenAPI do aplikacji NestJS, wskazując, co powstaje samo, a co trzeba dopisać ręcznie.