ochoajuanm / salaries-api-rest

Paginación de API REST desarrollada en Flask para exponer datos de una base

Paginación de API REST

Este proyecto tiene como finalidad exponer los datos de una base de datos de numerosos registros mediante una API que pueda paginar los resultados. La API fue desarrollada en Flask y se creó una base PostgreSQL poblada con un dataset de Kaggle

Estructura del proyecto

.
├── Dockerfile
├── exceptions.py
├── extensions.py
├── models.py
├── README.md
├── requirements.txt
├── schemas.py
├── server.py
├── template.env # Se debe renombrar a '.env' e indicar las variables de entorno
└── utils.py

Configuración del entorno e instalación de dependencias

Se debe usar el gestor de dependencias pip:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
python3 server.py

Ejecución con Docker

Realizamos build de la imagen partiendo de una imagen de Python

docker build -t salaries-api .
docker run -p 1337:1337 -it salaries-api /bin/bash

Una vez dentro del contenedor ejecutamos

python3 server.py

Finalmente podemos ejecutar http://127.0.0.1:1337/salaries?page=1&per-page=100 y veremos los resultados