Toggle navigation
Toggle navigation
This project
Loading...
Sign in
Martín Miranda
/
sage_api
Go to a project
Toggle navigation
Projects
Groups
Snippets
Help
Toggle navigation pinning
Project
Activity
Repository
Pipelines
Graphs
Issues
0
Merge Requests
0
Wiki
Network
Create a new issue
Builds
Commits
Authored by
Martín Miranda
2020-10-21 19:29:52 -0300
Browse Files
Options
Browse Files
Download
Email Patches
Plain Diff
Commit
a7b3741b4050e14a2dc8a41a24bacbe007c25f25
a7b3741b
1 parent
32aab097
Subo README con documentación para hacer el despliegue de la aplicación
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
52 additions
and
0 deletions
README.md
README.md
0 → 100644
View file @
a7b3741
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
-
[
Listado de sexos
](
http://localhost:8000/sexos/
)
-
[
Listado de personas
](
http://localhost:8000/personas/
)
-
[
Listado de personas limitando a 30 registros
](
http://localhost:8000/personas/?limit=30
)
-
[
Listado de personas filtrando por número de documento
](
http://localhost:8000/personas/?search=32628830
)
-
[
Detalle de una persona por su id
](
http://localhost:8000/personas/120/
)
...
...
Please
register
or
login
to post a comment