避免使用TSOA（Express）生成的Swagger.json中的推断响应类型。
创始人
2024-12-16 17:00:31
0次

在使用TSOA（Express）生成Swagger.json文档时，如果在控制器中返回了不同的类型，会推断响应类型并添加到生成的Swagger.json中，可能会导致文档的不准确性。避免这个问题的方法是在控制器中使用@Response装饰器来明确指定响应类型。

示例代码：

@Route('users')
export class UserController extends Contoller {
  @Get('{userId}')
  @Response(404, 'User not found')
  public async getUserById(@Path() userId: string): Promise {
    const user = await userService.getUserById(userId);
    if (!user) {
      throw new UserNotFoundError();
    }
    return user;
  }
}

在@Response装饰器中指定要返回的响应类型和状态码。这样可以避免TSOA推断响应类型。

在生成Swagger.json文档时，响应类型将被准确描述。

上一篇：避免使用try-catch块的异步/等待错误处理

下一篇：避免使用图标混淆多个vscode实例

相关内容

热门资讯

科普攻略！德普之星辅助器app... 科普攻略！德普之星辅助器app，we poker辅助器，德州论坛（有挂软件）是一款可以让一直输的玩家...
重大科普！佛手在线大菠萝智能辅... 重大科普！佛手在线大菠萝智能辅助器，wepoker作弊辅助，分享教程（有挂软件）；原来确实真的有挂（...
一分钟教会你！wepoker怎... 一分钟教会你！wepoker怎么增加运气，epoker透视，切实教程（有挂透视）1、点击下载安装，微...
六分钟了解！hhpoker有辅... 六分钟了解！hhpoker有辅助吗，wepoker国外版透视，扑克教程（有挂技巧）科技教程也叫必备教...
我来教大家！wepoker辅助... 我来教大家！wepoker辅助透视，wepoker免费脚本弱密码，详细教程（有挂透明）；wepoke...
记者发布！wpk辅助，德普之星... 记者发布！wpk辅助，德普之星透视辅助软件激活码，解密教程（有挂辅助）；亲真的是有正版授权，小编（透...
揭秘攻略！aapoker万能辅... 《揭秘攻略！aapoker万能辅助器，hhpoker真的假的，揭秘教程（有挂教程）》 aapoker...
重大通报！sohoo poke... 自定义sohoo poker辅助器系统规律，只需要输入自己想要的开挂功能，一键便可以生成出微扑克专用...
三分钟了解！wpk辅助器，hh... 1、三分钟了解！wpk辅助器，hhpoker免费辅助器，必赢教程（有挂神器）；详细教程。2、hhpo...
玩家必看攻略！wejoker私... 玩家必看攻略！wejoker私人辅助软件，智星德州可以透视吗，透明挂教程（有挂技巧）关于智星德州可以...