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

相关内容

热门资讯

曝光透视!哈糖大菠萝有挂吗!真... 曝光透视!哈糖大菠萝有挂吗!真是有辅助方法(发现有挂)-哔哩哔哩1、在哈糖大菠萝有挂吗插件功能辅助器...
必备透视!菠萝德普辅助器免费版... 必备透视!菠萝德普辅助器免费版在哪里!一贯存在有辅助插件(有挂功能)-哔哩哔哩该软件可以轻松地帮助玩...
解迷透视!sohoopoker... 解迷透视!sohoopoker辅助!本来真的是有辅助软件(讲解有挂)-哔哩哔哩一、sohoopoke...
分享透视!xpoker怎么作必... 分享透视!xpoker怎么作必弊!原来一直总是有辅助脚本(真的有挂)-哔哩哔哩1、进入游戏-大厅左侧...
解密透视!pokermaste... 解密透视!pokermaster修改器!其实真的有辅助技巧(证实有挂)-哔哩哔哩1、下载好poker...
了解透视!拱趴大菠萝万能挂图解... 了解透视!拱趴大菠萝万能挂图解!一贯真的是有辅助神器(发现有挂)-哔哩哔哩1、下载好拱趴大菠萝万能挂...
科普透视!约局吧开挂!果然有辅... 您好，约局吧开挂这款游戏可以开挂的，确实是有挂的，需要了解加去威信【136704302】很多玩家在这...
揭幕透视!pokermaste... 揭幕透视!pokermaster脚本!竟然是有辅助app(有挂方略)-哔哩哔哩1、pokermast...
关于透视!newpoker怎么... 关于透视!newpoker怎么安装脚本!总是一直都是有辅助插件(有挂实锤)-哔哩哔哩1、超多福利：超...
详细透视!约局吧app有挂吗!... 详细透视!约局吧app有挂吗!真是是真的有辅助神器(有挂规律)-哔哩哔哩1、任何约局吧app有挂吗透...