/ISW-API

Primary LanguagePython

API Experimental ISW225-SJ27

About

API experimental de Habilitaciones, con el endpoint público en AWS

Intregantes

Proyecto de ramo Ingeniería de Software: INF 225
Universidad Técnica Santa María
2021-1

Instrucciones de uso:

La API posee el enpoint público en AWS. La documentación de la API se encuentra en Read The Docs

Testing:

Se implementa un programa test.py que verifica el correcto funcionamiento de la API. Para correr el programa se debe ejecutar alguno de los siguientes comandos:

python3 test.py -v- este comando corre el programa e imprime los estados detodos los tests durante su ejecución.

python3 test.py - este comando corre el programa. El programa no imprime nada por la pantalla en caso de que todos los test fueron exitosos.

python3 test.py --url - este comando corre el programa y prueba todos los métodos para la url específica(que debe incluir el puerto).Por defecto la url corresponde a IP de la instancia en AWS junto con el puerto (8000).

Métodos implementados:

Método GET /habilitacion/capacitaciones - método que se encarga de entregar todas las capacitaciones existentes en el sistema

curl --location --request GET 'ec2-18-221-241-253.us-east-2.compute.amazonaws.com:8000/habilitacion/capacitaciones'

Método GET /habilitacion/capacitados - método que permite obtener todos los ids de las personas capacitadas para una capacitación de id consultado

curl --location --request GET 'ec2-18-221-241-253.us-east-2.compute.amazonaws.com:8000/habilitacion/capacitados'

Método GET /habilitacion/capacitados/{id_capacitacion} - método que permite obtener las personas capacitadas para la capacitación de id=X.

curl --location --request GET 'ec2-18-221-241-253.us-east-2.compute.amazonaws.com:8000/habilitacion/capacitados/3'

Método GET /habilitacion/capacitaciones/{id_capacitado} - método que permite obtener todas las capacitaciones realizadas por una persona de id consultado. Recibe el id como parámetro. Un ejemplo de request para id=3 sería:

curl --location --request GET 'ec2-18-221-241-253.us-east-2.compute.amazonaws.com:8000/habilitacion/capacitaciones/3'

Método GET /habilitacion/recursos/{id_capacitacion} - método que permite obtener todos los recursos asociados a una capacitación de id consultado

curl --location --request GET 'ec2-18-221-241-253.us-east-2.compute.amazonaws.com:8000/habilitacion/recursos/2

Método GET /habilitacion/capacitado/{id_persona}/{id_capacitacion} - método que permite revisar si una persona de id=X ha realizado la capacitación de id=Y. Por ejemplo, para revisar si la persona con id=3 tiene capacitación deid=2podemos hacer el siguiente request:

curl --location --request GET 'ec2-18-221-241-253.us-east-2.compute.amazonaws.com:8000/habilitacion/capacitado/3/2'