node + swagger = combinación perfecta

Hola amigos de la #nerdytud.

Hoy les comparto el procedimiento más sencillo para documentar nuestra api en node, documentándo la misma con swagger.

crear aplicación

mkdir dummy && cd dummy

npm init -y

instalar librerías

npm i express

npm i swagger-autogen

npm i swagger-ui-express

modificar package.json

"scripts": {
  "start": "node app.js",
  "create-doc": "node swagger.js"
},

crear archivo swagger.js

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

const outputFile = './swagger_output.json';
const endpointsFiles = ['./app.js'];

swaggerAutogen(outputFile, endpointsFiles);

generar swagger_output.json

npm run create-doc

agregar referencia de swagger_output.json en app.js

const swaggerUi = require('swagger-ui-express')
const swaggerFile = require('./swagger_output.json')

app.use('/docs', swaggerUi.serve, swaggerUi.setup(swaggerFile))

ejecutar server

nmp start

http://localhost:3000/doc