金色时刻 · 15:48
让好资源,触手可及
AGENT SKILL

api-standards

api-standards 是面向软件开发的 Agent Skill,来自 HoangNguyen0403/agent-skills-standard。查看技能说明、操作步骤与使用约定,并通过原项目了解详细用法。

Response wrapping, pagination, and error standardization.

SKILL.md

下载 MD ↓
nameNestJS API Standards
descriptionResponse wrapping, pagination, and error standardization.
metadata{"labels": ["nestjs", "api", "pagination", "response"], "triggers": {"files": ["**/*.controller.ts", "**/*.dto.ts"], "keywords": ["ApiResponse", "Pagination", "TransformInterceptor"]}}

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.

来源:HoangNguyen0403/agent-skills-standard · MIT 许可 · 许可原文 · MD 为来源页保存的历史版本