我可以使用Express API with autogenerated OpenAPI doc through Swagger文章配置swagger url。
我使用的是TypeScript，它在dist下生成.js文件，没有添加任何API文档注解。将apis: ['../dist/*.js']或Route.ts指向都会生成API详细信息。我没有使用任何休息装饰。
/**
* @swagger
* /:
* get:
* description: This should return ok
*/
this.router.get("/", (req: Request, res: Response) => this.api.process(req, res));Routes.ts API文档与上面类似。如何生成swagger文档？
1条答案
按热度按时间vaj7vani1#
我建议你使用一个库来为你处理一切，比如tsoa，它可以很容易地从你的TypeScript类型生成Swagger/OpenAPI文档。它还为您执行运行时验证，以便您知道请求实际上是TypeScript所说的类型。自述文件包含了开始使用它所需的所有设置信息。它与express、hapi、koa等兼容：
https://github.com/lukeautry/tsoa
(Full透明度：我是tsoa的维护者之一。但我首先是tsoa的消费者，我发现它是一个伟大的产品。所以我才要求帮忙维护（第二章）