README.md

Swagger Demo with Node.js

Reference

• Swagger YML reference
• swagger-ui-express module
• Adding Swagger To Existing Node.js Project by Ivan Vasiljevic

How to build and run this project

Install dependencies (you can do both using npm, yarn)

yarn

or

npm install

Run the APIs

yarn start

Once app is running, you can view the API doc using URL http://localhost:3000/api/v1/docs, this will be read only doc but you can tryout the APIs

Edit or Design API document interactively

yarn api-edit

Run for API tests using swagger

yarn api-test