prueba-fast-api

Prueba del framework fast-api para hacer API REST con python.

Instalación

• Ejecutar tarea 🔁 Nuevo entorno.
• Ejecutar tarea 📦 Instalar.

Alternativamente, en consola.

python -m venv .venv
source .venv/bin/activate
pip install -r requirements/dev.txt
pip install -e .

Lanzar el servidor

• Ejecutar tarea ▶️ Ejecutar.

Alternativamente, en consola.

fastapi dev src/api_prueba/main.py

Documentación de la API

• Ejecutar tarea 🌐 Docs.

Alternativamente, en consola.

# Windows
cmd /c start http://127.0.0.1:8000/docs
# Linux
xdg-open http://127.0.0.1:8000/docs
# MacOS
open http://127.0.0.1:8000/docs

Actualizar dependencias

• Editar requirements.in o requirements-dev.in.
• Ejecutar tarea 📥 Actualizar.
• Ejecutar tarea 📦 Instalar.

Alternativamente, en consola.

source .venv/bin/activate
pip-compile --strip-extras --output-file=requirements/prod.txt requirements.in
pip-compile --output-file=requirements/dev.txt requirements-dev.in
pip install -r requirements/dev.txt

Comprobar guía de estilo

• Ejecutar tarea 🔍 Lint.

Alternativamente, en consola.

ruff check src tests

Ejecutar tests

• Ejecutar tarea 🧪 Tests.

Alternativamente, en consola.

pytest

Comprobar cobertura

• Ejecutar tarea 📊 Cobertura.

Alternativamente, en consola.

# Windows
cmd /c start htmlcov\\index.html
# Linux
xdg-open htmlcov/index.html
# MacOS
open htmlcov/index.html