README.md 1.37 KB

SAGE API

Versión de prueba para la API del SAGE.

Requerimientos

  • Python > 3.6
  • FastAPI (Starlatte)
  • Pydantic
  • SQLAlchemy
  • uvicorn (para desplegar la aplicación)

Estructura de archivos planteada.

  • sage_api
    • project
      • apps
        • persona
          • models.py
          • routers.py
          • schemas.py
      • config.py
      • database.py
      • main.py
    • requerimients
      • base.txt
      • development.txt
    • .env

Despliegue

  • Crear un entorno virtual sage_api con la versión de python > 3.6
  • Instalar los requerimientos con pip install -r requirements/development.txt
  • Copiar el archivo .env a partir env.example
    • Modificar la variable DATABASE_URL con los datos de acceso correctos.

Correr el servidor.

Para correr el server y probar la API será necesario posicionarnos a la altura del archivo main.py y ejecutar en la shell: uvicorn main:app --reload

Endpoints disponibles de ejemplo