https://github.com/saopayne/grocery_store_api
This is an API repository of a grocery store.
https://github.com/saopayne/grocery_store_api
Last synced: 6 days ago
JSON representation
This is an API repository of a grocery store.
- Host: GitHub
- URL: https://github.com/saopayne/grocery_store_api
- Owner: saopayne
- License: mit
- Created: 2018-11-15T08:25:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T00:47:06.000Z (about 2 years ago)
- Last Synced: 2024-12-06T20:28:09.844Z (3 months ago)
- Language: Python
- Size: 198 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RideCo Grocery Project API
This is the RESTful API for the Grocery App, the app that allows you to make and edit grocery list.
## Dependencies
1. Flask version 0.12+
2. Python version 3.6
3. MySQL 5.7
## How to run flask application
1. Clone the repository to your computer
2. Activate your virtualenv
3. In your terminal, enter the directory Rideco_grocery_api
4. run the following command to install the app package into your virtualenv (Don't forget the dot at the end)
``` pip install -r requirements.txt ```
5. To start the app, run the following commands in succession still in the same directory
```export FLASK_APP=flask_app/run.py```
```export FLASK_DEBUG=true ```
```export DATABASE_URL="sqlite://"```
```export APP_SETTINGS="development"```
```export SECRET="the-development-key-secret-hide-very-far"```
```flask run ```
_On windows, use 'set' instead of 'export'_
## How to test the flask appliaction
1. Clone the repository to your computer
2. Ensure you have the dependencies on your system
3. Install Coverage.py in your virtualenv using your terminal
``` pip install coverage```
4. run command in the folder Grocery List API
```
sh -c 'python manage.py test --coverage && coverage report'
```
5. Observe the output in your terminal
## API Documentation
Base URL: https://guarded-brook-31463.herokuapp.com
### Current endpoints
1. **Register user**
Endpoint:
```
/auth/register
```
Example POST payload :
```json
{
"username": "any-you-want",
"name": "Your name",
"email": "[email protected]",
"password": "password"
}
```
2. **Login**
Endpoint:
```
/auth/login
```
Methods = ['POST']
Example POST payload :
```json
{
"username": "any-you-want",
"password": "password"
}
```
3. **Grocery lists**
Endpoint:
```
/grocerylists/
```
Search by title:
```
/grocerylists/?q=placeholder
```
Example GET Pagination:
```
/grocerylists/?page=3&limit=4
```
Methods = ['POST', 'GET']
Authentication header:
```
Authorization: Bearer
```
Example POST payload :
```json
{
"title": "your new grocery list title",
"description": "whatever description"
}
```
Example response to GET:
```json
[
{
"title":"whatever title",
"description":"whatever description"
},
{
"title":" another title",
"description":"another description"
},
...
]
```
4. **Single Grocery List**
Endpoint:
```
/grocerylists/
```
Methods = ['PUT', 'GET', 'DELETE']
Authentication header:
```
Authorization: Bearer
```
Example PUT payload :
```json
{
"title": "your modified grocery list title",
"description": "whatever new description"
}
```
Example response to GET:
```json
{
"title":"whatever title",
"description":"whatever description"
}
```
5. **Items in a Grocery list**
Endpoint:
```
/grocerylists//items/
```
Search by name:
```
/grocerylists//items/?q=whatever_name_you_want
```
Example GET Pagination:
```
/grocerylists//items/?page=3&limit=4
```
Methods = ['POST', 'GET']
Authentication header:
```
Authorization: Bearer
```
Example POST payload :
```json
{
"name": "name of new item",
"quantity": 50,
"unit": "baskets"
}
```
Example response to GET:
```json
[
{
"name":"whatever name",
"quantity":8,
"unit": "whatever units"
},
{
"name":"baking flour",
"quantity":8,
"unit": "kg"
},
...
]
```
6. **Single Item of Grocerylists**
Endpoint:
```
/grocerylists//items/
```
Methods = ['PUT', 'GET', 'DELETE']
Authentication header:
```
Authorization: Bearer
```
Example PUT payload :
```json
{
"name": "modified name of item",
"quantity": 500,
"unit": "NGN"
}
```
Example response to GET:
```json
{
"name":"baking flour",
"quantity":8,
"unit": "kg"
}
```