Я добавляю комментарии swagger-jsdoc к существующему приложению Express с маршрутизаторами.
Приложение использует вложенные маршрутизаторы, где определенный файл маршрутизатора не отвечает за префикс конечной точки.
Например:
server.js
app.use('/api/users', usersRouter);
usersRouter.js
/**
* @swagger
* /api/users:
* post:
* ...
*/
router.post('/', usersPost);
Как вы можете видеть часть URL, определенную на сервере.js, но путь swagger находится в usersRouter.js.
То, что я ищу, - это какой-то способ определения префикса конечной точки пути сваггера в том же месте, где определена маршрутизация.Что-то вроде:
server.js
/**
* @swagger
* apiUsersPath: /api/users
*/
app.use('/api/users', usersRouter);
usersRouter.js
/**
* @swagger
* `${apiUsersPath}:
* post:
* ...
*/
router.post('/', usersPost);