Skip to content

mazipan/sample-swagger-for-nodejs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sample-swagger-for-nodejs

Sample of using http://swagger.io/ for nodejs especially express framework.

Preview

Using technology

- NodeJS and Expressjs API development - Swagger and Swagger UI for documentation

Installation

- Install depedency https://github.com/swagger-api/swagger-node
npm install -g swagger
- Install all depedency
npm install
- Run mongodb
mongod
- Run the server
swagger project start
- Open swagger editor
swagger project edit
- Open API documentation in browser
http://localhost:10010/docs/#/default

Folder Structure

- all code in api folder - api/connection/connection.js is mongodb connection - app.js is main server js - folder api/controllers is all api routing - folder api/models is schema model for mongodb ORM - folder api/swagger is configuration for swagger UI
**Hope will usefull for you all.**

Contact Me :

Email Website Facebook

Twitter Linkedin Slideshare

About

📚 Sample of using swagger.io with Nodejs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published