Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erdem/flask-restful-example
A RESTful contact API implementation with using Flask SQLAlchemy, PyTest, Marshmallow and Celery.
https://github.com/erdem/flask-restful-example
celery celerybeat flask flask-sqlalchemy marshmallow pytest restful-api sqlalchemy
Last synced: 1 day ago
JSON representation
A RESTful contact API implementation with using Flask SQLAlchemy, PyTest, Marshmallow and Celery.
- Host: GitHub
- URL: https://github.com/erdem/flask-restful-example
- Owner: erdem
- Created: 2019-07-28T22:49:02.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-01-06T22:36:07.000Z (almost 3 years ago)
- Last Synced: 2024-12-22T17:07:01.541Z (1 day ago)
- Topics: celery, celerybeat, flask, flask-sqlalchemy, marshmallow, pytest, restful-api, sqlalchemy
- Language: Python
- Homepage:
- Size: 25.4 KB
- Stars: 35
- Watchers: 3
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Flask Example
=============
This repository contains the example code for a contact API project, using SQLAlchemy, PyTest, Celery with Flask.
### Tasks
- Model a Contact with username, email, first name and surname.
- Create a Restful API that returns a list of all contacts.
- Returns a contact by username.
- Saves a Contact.
- Updates a Contact
- Deletes a Contact
- Allow a contact to have multiple email addresses. Adjust GET, POST, PUT, DEL methods to the new sub entity.
- Extend the GET to also accept the email address for contact retrieval.
- Implement a celery task to create a random contact with two email addresses every 15 seconds. Any older entries then 1 min should be cleaned up and deleted.
Setup
-----
1. Clone this repository.
2. Create a virtualenv and activate.
3. Install requirement packages.
4. Make sure `redis-server` running on background.
5. Set `FLASK_ENV` environment variable as `development`. (`export FLASK_ENV=development`)
6. Open a second terminal and start celery: `celery worker -A celery_worker.celery --loglevel=info`.
7. Open a third terminal and start celery-beat: `celery -A celery_worker:celery beat --loglevel=INFO`.
8. Start the Flask application on your original terminal window: `flask run`.
9. Go to `http://localhost:5000/api/contacts/` and enjoy!
> You can run the tests with `pytest tests` command.
Some example usage for Contact API
----------------------------------
##### Creating a contact entity
```bash
curl -X POST \
http://localhost:5000/api/contacts/ \
-H 'Content-Type: application/json' \
-d '{
"username": "admin",
"first_name": "Armin",
"last_name": "Ronacher",
"emails": [
{"email": "[email protected]"}
]
}'
```
##### Updating a contact entity
```bash
curl -X PATCH \
http://localhost:5000/api/contacts/admin/ \
-H 'Content-Type: application/json' \
-d '{
"emails": [
{"email": "[email protected]"}
]
}'
```
##### Get list of contacts by username
```bash
curl -X GET http://localhost:5000/api/contacts/admin/
```