DEV Community

Autogenerated documentation API with OpenAPI and Swagger for NodeJS and Express

Luiz Calaça on February 15, 2022

Hi, Devs! That's really important a documentation and good patterns of our API, it shows in cleanable way what is available. There are ...

Read full post

Diogo • Jun 29 '22

Hi Luiz, how are you? ... to export more endpoints i just need put it inside of array right?

i mean like:
const endpointsFiles = [
'./routes/productsRouter.js',
'./routes/salesRouter.js',
];

Luiz Calaça • Jul 1 '22

Certainly, Diogo! Just include all routes into endpointFiles like you wrote.

Luiz Calaça • Jul 1 '22 • Edited

Your example is exactly what is writing on documentation: github.com/davibaltar/swagger-auto...

const outputFile = './path/swagger-output.json';
const endpointsFiles = ['./path/endpointsUser.js', './path/endpointsBook.js'];

/* NOTE: if you use the express Router, you must pass in the
'endpointsFiles' only the root file where the route starts,
such as index.js, app.js, routes.js, ... */

swaggerAutogen(outputFile, endpointsFiles);

Matheus H. • Sep 20 '22

This post helped me, thank you Calaça!

Ricardo Sousa • Mar 1 '22

it's a lot of Pequi in the veins!

Luiz Calaça • Mar 2 '22

Hahaha

SaTy • Oct 19 '22

Thanks for sharing!

Tamir • Apr 14 '23

Just pointing out if you have somehow swagger.js file in src directory and got routes in src directory as well routes/yourRouteName.js won't work got to add src/routes/yourRouteName.js