УЗЕЛ: Как заставить swagger показывать маршрут конечную точку в документации

#node.js #swagger #documentation

Вопрос:

Я документирую существующий API узла. Для этой задачи я использую swagger-ui-express amp;amp; swagger-автоген.

Все маршруты находятся внутри routes.js вот так:

 router.use('/my_route', require('./my_routes.js'));
 

И внутри my_routes.js у меня есть много конечных точек , таких как эта:

 router.get('/', custom1.customFunction1);
router.get('/:custom2/:custom3', custom1.customFunction23);
router.put('/custom4', custom4.customFunction4);
 

Проблема в том, что на /documentation странице все мои конечные точки отображаются следующим образом:
конечные точки swagger

Как я могу сделать шоу чванства таким образом: конечные точки чванства, которые я хочу

Большое спасибо!

Ответ №1:

Попробуйте настроить свой swagger.js файл, передающий только routes.js файл, такой как:

 const swaggerAutogen = require('swagger-autogen')();


const outputFile = './swagger-output.json';
const endpointsFiles = ['./routes.js'];

swaggerAutogen(outputFile, endpointsFiles);