README.md

Project Learn Swagger

Background

Learn and Share how to use swagger IO in your API development. author : nando teddy

Table of Contents

• Objective
• Prerequisite
• Contributing
• Changelog

Objective

1. With this API Project you will know how to learn and utilize Swagger with Open Api Spec
2. With this API Project you will understand how to utilize node js + express

Prerequisite

1. In order to utilize this API sample u need to understand basic concept of

   • JSON : https://json.org
   • YAML : http://yaml.org
   • NODE JS : https://nodejs.org/en/
   • EXPRESS : https://expressjs.com/
   • POSTGRESQL : https://www.postgresql.org/
   • SWAGGER CODE EDITOR : https://editor.swagger.io/
   • NPM : https://www.npmjs.com/

2. Clone or Fork This repository https://github.com/ndoteddy/Project-Learn-Swagger

3. Npm package manager will auto download node module for u according to a Json Package

   • clone this repository
   • go to your directory using terminal (KDE/UBUNTU/OSX) or Command Prompt (Windows) or SourceTree
   • make sure npm already installed
   • npm install
   • wait for a minutes (or maybe 5 minutes :D)
   • install postgresql
   • run this command (psql.exe -U (your username) -d (your dbname) -f tshirt.sql)
   • change connection string in 'queries.js' line 9 var connectionString = 'postgres://:@localhost:5432/tshirt';
   • npm start

4. Happy coding

5. Hosting

   • You can host in any Node JS Platform, my recommendation
   • Heroku | AWS | Azure

6. You can add me on dribble

   • https://dribbble.com/nandoteddy
   • Because this API load image from my Dribble :D

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

See Contributing and List of our contributor here Contributors

Changelog

See detail of Project Changes on Changelog