Ejemplo de como realizar un API Rest sencillo con Flask
.gitignore | ||
app.py | ||
env | ||
fake_data.py | ||
models.py | ||
Pipfile | ||
README.md |
Microframework Web
- Flask
Base de datos
- Flask-SQLAlchemy: ORM
- Flask-Migrate: Añade herramientas para gestionar nuestra base de datos.
- Flask-Script: Creación de comandos personalizados
- Faker: Generador de información falsa
API Rest
- Flask-restplus: Nos ayuda con las peticiones y autodocumentación
- Flask-JWT: Identificación básica.
- Flask-marshmallow: Convertirá los objetos ORM en JSON.
Herramientas de desarrollo
- httpie: Cliente de API Rest para pruebas.
- python-dotenv: Implementación de un archivo de configuración.
Instalación
pipenv install flask Flask-SQLAlchemy Flask-Migrate Flask-script Faker
pipenv run python3 models.py db init
pipenv run python3 models.py db migrate
pipenv run python3 models.py db upgrade
pipenv run python3 fake_data.py
Ejecución
pipenv run python3 app.py
Peticiones
GET
http GET localhost:5000/api/v1/user
http GET localhost:5000/api/v1/user/{id}
http GET localhost:5000/api/v1/notice
http GET localhost:5000/api/v1/notice/{id}
http GET localhost:5000/api/v1/notice/{id}/comments
POST
http POST localhost:5000/api/v1/notice
http POST localhost:5000/api/v1/notice/{id}/comments
PATCH
http PATCH localhost:5000/api/v1/notice/{id}
DELETE
http DELETE localhost:5000/api/v1/notice/{id}