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

Question

我正在尝试在API文档中成功响应后显示错误响应。例如：-

@ApiResponse（{状态：401，描述：'invalid_client'}）（正在运行）

但是我也想给一个customCode ：:-

@ApiResponse（{状态：401，** customCode **：'invalid_token'，描述：'invalid_client'}）

但是在添加customCode时出现错误：-

错误是：-类型为'{status：number;的参数。 customCode：字符串；描述：字符串； }”不能分配给“ ApiResponseOptions”类型的参数。 对象文字只能指定已知的属性，而'customCode'在'ApiResponseOptions'类型中不存在。

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

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

Answer 1

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