Subo README con documentación para hacer el despliegue de la aplicación
Showing
1 changed file
with
52 additions
and
0 deletions
README.md
0 → 100644
1 | +SAGE API | ||
2 | +======== | ||
3 | + | ||
4 | +Versión de prueba para la API del SAGE. | ||
5 | + | ||
6 | +### Requerimientos | ||
7 | +- Python > 3.6 | ||
8 | +- FastAPI (Starlatte) | ||
9 | +- Pydantic | ||
10 | +- SQLAlchemy | ||
11 | +- uvicorn (para desplegar la aplicación) | ||
12 | + | ||
13 | + | ||
14 | +### Estructura de archivos planteada. | ||
15 | + | ||
16 | +- sage_api | ||
17 | + - project | ||
18 | + - apps | ||
19 | + - persona | ||
20 | + - models.py | ||
21 | + - routers.py | ||
22 | + - schemas.py | ||
23 | + - config.py | ||
24 | + - database.py | ||
25 | + - main.py | ||
26 | + - requerimients | ||
27 | + - base.txt | ||
28 | + - development.txt | ||
29 | + - .env | ||
30 | + | ||
31 | + | ||
32 | +### Despliegue | ||
33 | + | ||
34 | +- Crear un entorno virtual `sage_api` con la versión de python > 3.6 | ||
35 | +- Instalar los requerimientos con `pip install -r requirements/development.txt` | ||
36 | +- Copiar el archivo `.env` a partir `env.example` | ||
37 | + - Modificar la variable `DATABASE_URL` con los datos de acceso correctos. | ||
38 | + | ||
39 | + | ||
40 | +### Correr el servidor. | ||
41 | + | ||
42 | +Para correr el server y probar la API será necesario posicionarnos a la altura | ||
43 | +del archivo main.py y ejecutar en la shell: `uvicorn main:app --reload` | ||
44 | + | ||
45 | + | ||
46 | +### Endpoints disponibles de ejemplo | ||
47 | + | ||
48 | +- [Listado de sexos](http://localhost:8000/sexos/) | ||
49 | +- [Listado de personas](http://localhost:8000/personas/) | ||
50 | +- [Listado de personas limitando a 30 registros](http://localhost:8000/personas/?limit=30) | ||
51 | +- [Listado de personas filtrando por número de documento](http://localhost:8000/personas/?search=32628830) | ||
52 | +- [Detalle de una persona por su id](http://localhost:8000/personas/120/) |
-
Please register or login to post a comment