SuperAPI AI 工具集

nestjs-api-standards

编程与开发

查看项目

更新于 10-15 22:13

技能介绍

用途:为 NestJS 项目建立统一的 API 响应规范,覆盖响应包裹、分页端点与错误拦截器,适用于实现响应包装、分页 DTO 或错误处理的场景。

主要能力与工作流(标准化 API 端点):为每个端点返回类型定义专用 Response DTO;在 service 或 controller 中用 plainToInstance(UserResponseDto, user) 将实体映射为 DTO;全局绑定 TransformInterceptor,把所有响应包裹为 { statusCode, data, meta };为嵌套 DTO 属性添加 @ValidateNested() 与 @Type() 校验;用 @ApiResponse({ status, type }) 按端点标注精确类型。

分页规范:使用严格的 PageOptionsDto(page/take/order)与 PageDto<T>(data/meta);泛型需配合 ApiExtraModels 与 schema 路径解析。

错误响应:定义 ApiErrorResponse,包含 statusCode、message、error、timestamp、path;通过 @ApiBadRequestResponse({ type: ApiErrorResponse }) 全局或按控制器应用。

反模式:不要直接返回原始实体(会泄露内部字段),应始终映射为 Response DTO;不要使用未校验的嵌套 DTO;不要使用泛化的 200 文档,应按端点标注精确类型。

限制:资料未提供具体安装命令、依赖版本、完整代码示例与平台支持信息,暂未提供。