typescript - 从 typescript 接口(interface)生成 swagger 文档

Question

我正在使用 swager-jsdoc记录应用程序的所有 DTO。

我想知道有什么方法可以从 typescript 界面自动生成 swagger 文档。

我在项目中有很多，还有很多 Mongoose 模式和模型。让它们保持同步变得越来越乏味。另一方面，我不想使用 swagger 生成工具。我更喜欢自下而上的方法。

干杯

Answer 1

tsoa 的另一个选项是 routing-controllers + routing-controllers-openapi .两者之间的主要区别 (AFAIK) 是 tsoa依赖于代码生成，而 routing-controllers完全在运行时运行。这两种方法都有其优点:tsoa能够例如使用更丰富的元数据(例如代码注释)，而使用 routing-controllers我们可以跳过生成步骤。我的建议是两个都去看看!
另一种选择是typescript-json-schema ，它从 Typescript 接口(interface)生成 JSON Schema；在 JSON Schema 中定义模型后，您离 OpenAPI 规范并不遥远。