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

相关内容

热门资讯

透视了解！pokemmo脚本辅... 透视了解！pokemmo脚本辅助器下载，wepoker轻量版辅助，秘籍教程（都是存在有挂）-哔哩哔哩...
透视了解！wepoker免费透... 透视了解！wepoker免费透视脚本，德普之星辅助器app，方式教程（切实是真的挂）-哔哩哔哩暗藏猫...
透视规律！拱趴大菠萝机器人，x... 透视规律！拱趴大菠萝机器人，xpoker怎么辅助，技法教程（好像存在有挂）-哔哩哔哩1、拱趴大菠萝机...
透视了解！wepoker透视功... 透视了解！wepoker透视功能下载，淘宝买wepoker透视有用吗，办法教程（切实真的是有挂）-哔...
透视黑科技！德普之星怎么设置埋... 透视黑科技！德普之星怎么设置埋牌，we-poker靠谱吗，模板教程（竟然真的有挂）-哔哩哔哩1、德普...
透视挂透视！epoker底牌透... 透视挂透视！epoker底牌透视，aapoker怎么提高中牌率，方案教程（其实真的是有挂）-哔哩哔哩...
透视好友！we-poker辅助... 透视好友！we-poker辅助器，wpk辅助哪里买，讲义教程（本来是真的挂）-哔哩哔哩1、起透看视 ...
透视好友房！德普之星的辅助工具... 透视好友房！德普之星的辅助工具介绍，wepoker辅助分析器，大纲教程（果然有挂）-哔哩哔哩1、德普...
透视透视！wepoker手机插... 透视透视！wepoker手机插件，wepoker辅助是真的吗，指引教程（原来真的是有挂）-哔哩哔哩1...
透视智能ai！we poker... 透视智能ai！we poker辅助器，wepoker怎么看底牌，举措教程（本来真的是有挂）-哔哩哔哩...