Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 2.19 KB

File metadata and controls

58 lines (38 loc) · 2.19 KB

Food Service API

Build Status Maintainability Coverage Status

A simple RESTplus API allowing users to CREATE orders. Then, they are able to READ, UPDATE and DELETE them.

Development SetUp

What you need to run this API.

  1. Python 3.
  2. Virtualenv environment.
  3. Postman.

Installation

How to get your development environment running.

  • Clone the repository.
  • Unzip the files to your preferred location.
  • cd into the food-api folder.
  • Install a virtual environment pip install virtualenv venv
  • Install the requirements.txt pip install -r requierments.txt
  • Install Postman.

Running Tests

  • cd into food-api RUN python run.py.

key: Content-Type value: application/json

Methods Endpoint Action
GET http://127.0.0.1:5000/v1/orders (get all your orders)
POST http://127.0.0.1:5000/v1/orders (create a new order)
GET http://127.0.0.1:5000/v1/orders/order_id (get a specific order by name)
PUT http://127.0.0.1:5000/v1/orders/order_id (update an existing order)
DELETE http://127.0.0.1:5000/v1/orders/order_id (delete a specific order by name)

Release History

  • 0.1.0

    • The first proper release

Meta

Gabriel Machel - @Ch3ll0h - machelgabriel@gmail.com

http://github.com/Chell0/food-api

Contributing

  1. Fork it yourname/yourproject/fork
  2. Create your feature branch git checkout -b feature/fooBar
  3. Commit your changes git commit -am 'Add some fooBar'
  4. Push to the branch git push origin feature/fooBar
  5. Create a new Pull Request