Node.js 如何从基于TypeScript的Express应用程序生成swagger API文档?

Node.js 如何从基于TypeScript的Express应用程序生成swagger API文档?,node.js,typescript,express,swagger,Node.js,Typescript,Express,Swagger,我能够使用本文配置swagger url 我使用的是TypeScript,它在dist下生成.js文件,其中没有添加任何API文档注释。指向API:['../dist/*.js']或Route.ts生成API详细信息。我没有使用任何休息装饰 /** * @swagger * /: * get: * description: This should return ok */ this.router.get("/", (req: Request, res: Response

我能够使用本文配置swagger url

我使用的是TypeScript,它在dist下生成
.js
文件,其中没有添加任何API文档注释。指向
API:['../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文档?

我建议您使用一个库,它可以为您处理所有事情,例如可以轻松地从您的TypeScript类型生成swagger/OpenAPI文档。它还为您执行运行时验证,以便您知道请求实际上是TypeScript所说的类型。自述文件包含开始使用它所需的所有设置信息。它与Express、HAPI、膝关节炎等更为兼容:



(完全透明:我是tsoa的维护者之一。但我是tsoa的第一个消费者,我发现它是一个很棒的产品…这就是为什么我要求帮助维护它!:)

使用tsoa,将它们的装饰器添加到您的控制器类中,我手动编写了API的yml文件,并使用redoc生成html文件。无法在有限的时间内使类型和注释正常工作。hapi服务器(非express)也有相同的解决方案?tsoa能否从纯类型脚本(即仅一个接口或类)生成OpenAPI文档?我浏览了文档,似乎需要一个节点应用程序来生成OpenAPI文档