Agent skill

NestJS API Standards

Response wrapping, pagination, and error standardization.

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/api-standards

Metadata

Additional technical details for this skill

labels
nestjs api pagination response
triggers
{
    "files": [
        "**/*.controller.ts",
        "**/*.dto.ts"
    ],
    "keywords": [
        "ApiResponse",
        "Pagination",
        "TransformInterceptor"
    ]
}

SKILL.md

NestJS API Standards & Common Patterns

Priority: P1 (OPERATIONAL)

Standardized API response patterns and common NestJS conventions.

Generic Response Wrapper

  • Concept: Standardize all successful API responses.
  • Implementation: Use TransformInterceptor to wrap data in { statusCode, data, meta }.

Pagination Standards (Pro)

  • 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 for the complete ApiPaginatedResponse decorator code.

Custom Error Response

  • Standard Error Object:

    typescript
    export class ApiErrorResponse {
      @ApiProperty()
      statusCode: number;
    
      @ApiProperty()
      message: string;
    
      @ApiProperty()
      error: string;
    
      @ApiProperty()
      timestamp: string;
    
      @ApiProperty()
      path: string;
    }
    
  • Docs: Apply @ApiBadRequestResponse({ type: ApiErrorResponse }) globally or per controller.

Expand your agent's capabilities with these related and highly-rated skills.

Didn't find tool you were looking for?

Be as detailed as possible for better results