从打字稿接口生成 swagger 文档

2024-03-30

我在用着swager-jsdoc https://github.com/Surnet/swagger-jsdoc记录应用程序的所有 DTO。

我想知道是否有任何方法可以从打字稿接口自动生成 swagger 文档。

我的项目中有很多这样的东西,还有很多猫鼬模式和模型。让它们保持同步变得很乏味。另一方面,我不想使用招摇生成工具。我更喜欢自下而上的方法。

Cheers


另一种选择tsoa https://stackoverflow.com/a/57479677/1763012 is 路由控制器 https://github.com/typestack/routing-controllers + 路由控制器 openapi https://github.com/epiphone/routing-controllers-openapi。两者之间的主要区别(据我所知)是tsoa依赖于代码生成,而routing-controllers完全在运行时运行。两种方法都有其优点:tsoa能够例如利用更丰富的元数据(例如代码注释),而routing-controllers我们可以跳过生成步骤。我的建议是检查两者!

另一种选择是typescript-json-架构 https://github.com/YousefED/typescript-json-schema,它从 Typescript 接口生成 JSON 模式;在 JSON Schema 中定义模型之后,您就离 OpenAPI 规范不远了。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

从打字稿接口生成 swagger 文档 的相关文章

随机推荐