避免使用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实例

相关内容

热门资讯

透视插件！wepoker可以设... 透视插件！wepoker可以设置盖牌-关于开挂透视辅助教程（有挂教学）透视插件！wepoker可以设...
最新技巧“浙江游戏大厅修改器”... 最新技巧“浙江游戏大厅修改器”原先有开挂辅助挂（确实有挂）;1、这是跨平台的浙江游戏大厅修改器黑科技...
透视挂透视！hhpoker可以... 透视挂透视！hhpoker可以开挂-揭露开挂透视辅助攻略（有挂攻略）1、hhpoker可以开挂系统规...
玩家必看分享“小程序微乐游戏辅... 玩家必看分享“小程序微乐游戏辅助器”其实有开挂辅助器（详细教程）;1、让任何用户在无需AI插件第三方...
透视工具！wepoker国外版... 透视工具！wepoker国外版透视-教你开挂透视辅助工具（了解有挂）1、全新机制【wepoker国外...
专业讨论“欢乐游戏城破解版内置... 专业讨论“欢乐游戏城破解版内置修改器”本来有开挂辅助脚本（了解有挂）；详细欢乐游戏城破解版内置修改器...
一分钟教你“宝宝游戏辅助”好像... 您好：宝宝游戏辅助这款游戏可以开挂的，确实是有挂的，很多玩家在这款游戏中打牌都会发现很多用户的牌特别...
透视最新！hhpoker透视挂... 透视最新！hhpoker透视挂实战视频-解谜开挂透视辅助攻略（有挂技术）1、超多福利：超高返利，海量...
9分钟了解“四川家园游戏辅助器... 9分钟了解“四川家园游戏辅助器平台交易”果然有开挂辅助下载（有挂规律）；亲真的是有正版授权，小编（透...
透视科技！wepoker智能辅... 透视科技！wepoker智能辅助插件-教你开挂透视辅助插件（有挂方针）1、进入到wepoker智能辅...