Giter VIP home page Giter VIP logo

delicious_api_swagger's Introduction

README

Delicious Foods REST API with Swagger

This is a REST API web service, build on RoR with swagger-docs and swagger-ui to help developer working on REST API faster. Swagger will generate docs for your API, and Swagger-UI will generate compact REST Client to test your API.

Feel free to add your favorite foods.

Available End Points

  • GET snacks => Retrieve all available snacks on database
  • POST snacks => Entry new snack to database
  • GET snacks/:id => Find snack by ID
  • GET snacks/findByOrigin => Find snack by origin
  • PUT snacks/{snackID} => Update snack, with ID
  • DELETE snacks/{snackID} => Delete snack, by ID
  • PUT snacks/restore => Clear current database, and refill with original datas

Prerequisites

Ruby v.2.4.0 - Beautiful and robust programming language Ruby on Rails v.5.0.2 - Bring happiness on your web apps development RubyGems - Install gem for your RoR apps Bundler - The best way to manages your ruby gems

Installing

Clone this repo

git clone

Update your gem

bundle install

Start your server

rails server

Open your browser

http://localhost:port

Built With

Ruby v.2.4.0 Ruby on Rails v.5.0.2 Swagger-docs Swagger-ui

Author

Akbar Firdiansyah

License

License This project is licensed under the MIT License

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.