Skip to content

This project is a reference for setting up automatically generated swagger docs based on jsDoc comments in an express application.

Notifications You must be signed in to change notification settings

RyanBrayDev/swagger-auto-gen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Swagger Auto Gen

This project is a reference for setting up automatically generated swagger docs based on jsDoc comments in an express application.

Dependencies

https://www.npmjs.com/package/swagger-jsdoc

https://www.npmjs.com/package/swagger-ui-express

Running the App

npm run start

To access the swagger ui, navigate yoiur browser to http://localhost:3000/api-docs

Generating the swagger docs via the command line

After installing swagger-jsdoc globally:

swagger-jsdoc ./routes/* -d ./swagger/swaggerDefinition.js -o ./swagger/swagger.yaml

About

This project is a reference for setting up automatically generated swagger docs based on jsDoc comments in an express application.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published