nestjs-swagger - 我们如何使用 swagger/nestjs 在 API 文档中添加一些自定义错误（相关键）？

Question

我试图在 API Docs 中成功响应后显示错误响应。例如：-

@ApiResponse({status: 401, description: 'invalid_client'}) （它正在工作）

但我想给一个customCode也喜欢： -

@ApiResponse({status: 401, **customCode **: 'invalid_token', description: 'invalid_client'})

但我在添加 customCode 时遇到错误：-

错误是：- '{ status: number; 类型的参数；自定义代码：字符串；描述：字符串；}' 不可分配给“ApiResponseOptions”类型的参数。对象字面量只能指定已知属性，并且“ApiResponseOptions”类型中不存在“customCode”。

我试图从 Nestjs/swagger 链接中找出答案，但找不到此问题的链接。

https://docs.nestjs.com/recipes/swagger#responses

Answer 1

您收到此错误是因为@ApiResponse()装饰器只需要您无法在此装饰器中添加 customCode 的已定义属性。但是，如果您愿意，您也可以使用其中的任何 customCode，status: yourCustomCode或者如果需要，您可以在 API 响应中返回 customCode。