在将swagger-jsdoc添加到现有Express应用中时进行跨文件注释

时间:2019-06-20 18:10:34

标签: node.js rest express swagger swagger-jsdocs

我在带有路由器的现有Express应用程序中添加了swagger-jsdoc注释。

该应用使用嵌套路由器,其中特定的路由器文件不负责端点前缀。

例如:

server.js

app.use('/api/users', usersRouter);

usersRouter.js

/**
* @swagger
* /api/users:
*   post:
* ...
*/
router.post('/', usersPost);

如您所见,在server.js中定义了url的一部分,但是挥舞的路径在usersRouter.js中。

我要寻找的是在定义路由的同一位置定义swagger path端点前缀的方法。像这样:

server.js

/**
* @swagger
* apiUsersPath: /api/users
*/
app.use('/api/users', usersRouter);

usersRouter.js

/**
* @swagger
* `${apiUsersPath}:
*   post:
* ...
*/
router.post('/', usersPost);

0 个答案:

没有答案