/nestjs-api-standards

Create standardized API response envelopes, paginated endpoints, and error interceptors in NestJS. Use when implementing response wrappers, pagination DTOs, or global error formats.

hoangnguyen0403@hoangnguyen0403

GitHub

From plugin

agent-skills-standard

538200 skills1 MCP

Install

$ npx -y skills add hoangnguyen0403/agent-skills-standard --skill nestjs-api-standards --agent claude-code

How it fires

How this skill gets triggered: by you, by Claude, or both.

Fires itselfAuto-invocation. Claude auto-loads it when your prompt matches the work.
You can call itInvoke it directly when you want it.
Slash command/nestjs-api-standards

Context preview

The summary Claude sees to decide when to auto-load this skill.

Create standardized API response envelopes, paginated endpoints, and error interceptors in NestJS. Use when implementing response wrappers, pagination DTOs, or global error formats.

SKILL.md

nestjs-api-standards.SKILL.md

name: nestjs-api-standards
description: Create standardized API response envelopes, paginated endpoints, and error interceptors in NestJS. Use when implementing response wrappers, pagination DTOs, or global error formats.
metadata:
  triggers:
    files:
    - '**/*.controller.ts'
    - '**/*.dto.ts'
    keywords:
    - ApiResponse
    - Pagination
    - TransformInterceptor

NestJS API Standards & Common Patterns

Priority: P1 (HIGH)

Workflow: Standardize API Endpoint

1. **Create Response DTO** — Define dedicated DTO for every endpoint return type. 2. **Map entity to DTO** — Use `plainToInstance(UserResponseDto, user)` in service or controller. 3. **Apply TransformInterceptor** — Bind globally to wrap all responses in `{ statusCode, data, meta }`. 4. **Add nested validation** — Decorate nested DTO properties with `@ValidateNested()` + `@Type()`. 5. **Document with Swagger** — Apply `@ApiResponse({ status, type })` with exact types per endpoint.

Response Wrapper Example

See [implementation examples](references/implementation.md)

Entity-to-DTO Mapping Example

See [implementation examples](references/implementation.md)

Deep Validation (Critical)

**[Rule] Nested Validation**: Object/array DTO properties require `@ValidateNested()` + `@Type(() => TargetDto)` from `class-transformer`.

Pagination Standards

**DTOs**: Use strict `PageOptionsDto` (page/take/order) and `PageDto<T>` (data/meta).
**Swagger Logic**: Generics require `ApiExtraModels` and schema path resolution.
**Reference**: See [Pagination Wrapper Implementation](references/pagination-wrapper.md) for complete `ApiPaginatedResponse` decorator code.

Custom Error Response

**Standard Error Object**: Define `ApiErrorResponse` with `statusCode`, `message`, `error`, `timestamp`, `path`. See [Error Response Class](references/error-response.md).
**Docs**: Apply `@ApiBadRequestResponse({ type: ApiErrorResponse })` globally or per controller.

Anti-Patterns

**No raw entity returns**: Always map to Response DTO; raw entities leak internal fields.
**No unvalidated nested DTOs**: Use `@ValidateNested()` + `@Type()` for all nested object properties.
**No generic 200 docs**: Apply `@ApiResponse({ status, type })` with exact types per endpoint.