Giter VIP home page Giter VIP logo

sample-swagger-for-nodejs's Introduction

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

sample-swagger-for-nodejs's People

Contributors

mazipan avatar

Stargazers

LUÍS CARLOS DE SOUZA MENEZES avatar devrajashwin avatar Alexander Elgin avatar avatar Mario Mol avatar Dhany avatar Joseph Bassey avatar Fari avatar Moch Fauz avatar Randy Vianda Putra avatar superical avatar avatar

Watchers

James Cloos avatar avatar

Forkers

reisap franschaniago lcsouzamenezes nap-bn-test

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.