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

相关内容

热门资讯

辅助透视！xpoker怎么作弊... 辅助透视！xpoker怎么作弊，epoker有透视吗，揭秘攻略（有挂细节）；1、epoker有透视吗...
透视挂！德扑圈透视挂，（德普之... 透视挂！德扑圈透视挂，（德普之星）确实有挂，实用技巧（有挂攻略）1、上手简单，内置详细流程视频教学，...
透视黑科技“聚星ai辅助工具下... 透视黑科技“聚星ai辅助工具下载”透视辅助工具（都是存在有挂）1、透视黑科技“聚星ai辅助工具下载”...
透视苹果版！德普之星透视软件免... 透视苹果版！德普之星透视软件免费入口官网，（德普）真是存在有挂，科技教程（有挂教程）1、德普之星透视...
透视线上！约局吧怎么看有没有挂... 透视线上！约局吧怎么看有没有挂，哈糖大菠萝软件下载，黑科技教程（有挂详情）1、完成约局吧怎么看有没有...
透视智能ai！德普软件，（德普... 透视智能ai！德普软件，（德普）原来存在有挂，新版2025教程（有挂详情）；在进入德普软件辅助挂后，...
透视辅助！agpoker辅助，... 透视辅助！agpoker辅助，约局吧是否有挂，切实教程（有挂解说）；1、约局吧是否有挂ai机器人多个...
透视辅助！德普之星怎么开辅助，... 透视辅助！德普之星怎么开辅助，（德扑之心）竟然是有挂，攻略方法（有挂规律）1）德普之星怎么开辅助辅助...
透视透视挂！哈糖大菠萝攻略，x... 透视透视挂！哈糖大菠萝攻略，xpoker辅助工具，曝光教程（有挂教程）1、游戏颠覆性的策略玩法，独创...
透视脚本！德普之星透视辅助软件... 透视脚本！德普之星透视辅助软件激活码，（德普）一直真的是有挂，2025新版技巧（有挂技巧）；1、玩家...