避免使用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透视辅助挂有游戏亮点”开挂辅助工具（透视）攻略方法是一款可以让一直输的玩...
最新技巧“微扑克辅助”开挂辅助... 无需打开直接搜索加微信客服（136704302）咨询了解微扑克辅助辅助器目前（微信:13670430...
一分钟快速了解“wepoker... >>您好：wepoker开挂辅助确实是有挂的，很多玩家在这款游戏中打牌都会发现很多用户的牌特别好，总...
重大来袭“wepoker有没有... 无需打开直接搜索加微信客服（136704302）咨询了解wepoker有没有挂辅助器目前（微信:13...
最新技巧“wepoker靠谱不... 您好：wepoker靠谱不这款游戏是可以开挂的，软件加【添加微信客服136704302】确实是有挂的...
免费测试版“wepoker有挂... 您好：wepoker有挂吗透视软件的软件，软件加客服确实是有挂的，很多玩家在这款游戏中打牌都会发现很...
一分钟了解“微扑克发牌规律”开... 微扑克发牌规律是一款可以让一直输的玩家，快速成为一个“必胜”的ai辅助神器，有需要的用户可以加我微信...
重大消息“wepoker可以透... 您好，wepoker可以透视开挂吗这款游戏可以开挂的，确实是有挂的，需要了解加微【136704302...
玩家攻略“wpk透视插件怎么安... 无需打开直接搜索;操作使用教程:玩家攻略“wpk透视插件怎么安装”开挂辅助器（透视）曝光教程1、界面...
教程攻略“wepoker能开挂... 您好：wepoker能开挂吗这款游戏可以开挂的，确实是有挂的，很多玩家在这款游戏中打牌都会发现很多用...