生成一个swagger.Json文件从代码中的注释

Question

我正在为用node.js编写的API创建文档

我手工创建了一个swagger.json文件，并将其输入swagger-ui前端，以制作漂亮的API文档。

然而，我想做的是能够以类似于JSDoc的方式从代码生成API文档-通过简单地用注释标记我的代码，然后运行直接从代码创建文档(在本例中为swagger.json文件)的命令。

实现这一点最简单的方法是什么?

Answer 1

您可以使用swagger-jsdoc库:

/**
* @openapi
* /:
*   get:
*     description: Welcome to swagger-jsdoc!
*     responses:
*       200:
*         description: Returns a mysterious string.
*/
app.get('/', (req, res) => {
res.send('Hello World!');
});