pjecz-plataforma-web-api-oauth2

API de Plataforma Web para brindar informacion a otros sistemas.

Mejores practicas

Usa las recomendaciones de I've been abusing HTTP Status Codes in my APIs for years

Respuesta exitosa

Status code: 200

Body que entrega un listado

{
    "success": true,
    "message": "Success",
    "result": {
        "total": 2812,
        "items": [ { "id": 1, ... } ],
        "limit": 100,
        "offset": 0
    }
}

Body que entrega un item

{
    "success": true,
    "message": "Success",
    "id": 123,
    ...
}

Respuesta fallida: registro no encontrado

Status code: 200

Body

{
    "success": false,
    "message": "No employee found for ID 100"
}

Respuesta fallida: ruta incorrecta

Status code: 404

Configure Poetry

Por defecto, con poetry el entorno se guarda en un directorio en ~/.cache/pypoetry/virtualenvs

Modifique para que el entorno se guarde en el mismo directorio que el proyecto

poetry config --list
poetry config virtualenvs.in-project true

Verifique que este en True

poetry config virtualenvs.in-project

Configuracion

Para produccion se toman los secretos desde Google Cloud con secret manager

Para desarrollo hay que crear un archivo para las variables de entorno .env

# Base de datos
DB_HOST=127.0.0.1
DB_NAME=pjecz_plataforma_web
DB_USER=adminpjeczplataformaweb
DB_PASS=XXXXXXXXXXXXXXXX

# CORS Origins separados por comas
ORIGINS=http://localhost:8006,http://localhost:3000,http://127.0.0.1:8006,http://127.0.0.1:3000

# Limite de citas pendientes por cliente
LIMITE_CITAS_PENDIENTES=30

# Redis
REDIS_URL=redis://127.0.0.1:6379
TASK_QUEUE=pjecz_plataforma_web

# Salt sirve para cifrar el ID con HashID, debe ser igual que en la app Flask
SALT=XXXXXXXXXXXXXXXXXXXXXXXX

# Timezone
TZ=America/Mexico_City

# Arrancar con gunicorn o uvicorn
ARRANCAR=uvicorn

Cree un archivo .bashrc que se puede usar en el perfil de Konsole

if [ -f ~/.bashrc ]; then
    source ~/.bashrc
fi

source .venv/bin/activate
if [ -f .env ]; then
    export $(grep -v '^#' .env | xargs)
fi

figlet Plataforma Web API Key
echo

echo "-- Variables de entorno"
export $(grep -v '^#' .env | xargs)
echo "   DB_HOST: ${DB_HOST}"
echo "   DB_NAME: ${DB_NAME}"
echo "   DB_USER: ${DB_USER}"
echo "   DB_PASS: ${DB_PASS}"
echo "   SALT: ${SALT}"
echo

export PGHOST=$DB_HOST
export PGPORT=5432
export PGDATABASE=$DB_NAME
export PGUSER=$DB_USER
export PGPASSWORD=$DB_PASS

alias arrancar="python3 ${PWD}/arrancar.py"
echo "-- Arrancar FastAPI con arrancar.py"
echo "   arrancar"
echo

Instalacion

En Fedora Linux agregue este software

sudo dnf -y groupinstall "Development Tools"
sudo dnf -y install glibc-langpack-en glibc-langpack-es
sudo dnf -y install pipenv poetry python3-virtualenv
sudo dnf -y install python3-devel python3-docs python3-idle
sudo dnf -y install python3-ipython

Clone el repositorio pjecz-plataforma-web-api-oauth2

cd ~/Documents/GitHub/PJECZ
git clone https://github.com/PJECZ/pjecz-plataforma-web-api-oauth2.git
cd pjecz-plataforma-web-api-oauth2

Instale el entorno virtual con Python 3.10 y los paquetes necesarios

poetry install

FastAPI

Ejecute el script arrancar.py que contiene el comando y parametros para arrancar el servicio

./arrancar.py

Google Cloud deployment

Ya contiene un GitHub Action para implementar en produccion cada vez que hay aportaciones a la rama principal.

Por lo que estos pasos ya no son necesarios...

1. Crear el archivo requirements.txt

   poetry export -f requirements.txt --output requirements.txt --without-hashes

2. Y subir a Google Cloud

   gcloud app deploy