API para el centro medico Galenos

Tabla de Contenidos:

• Prerrequisitos
  • Python
  • WSL
  • Docker
• Instrucciones de uso
  • Entorno Virtual
  • Dependencias
  • Levantar API con Docker
  • Consumir API

Prerrequisitos:

Para poder levantar esta API y consumirla es necesario cumplir con los prerrequisitos para proceder a instalar las dependencias y correr el código fuente.

1. Python:

Es necesario tener instalado desde Python 3 en adelante. Pagina Oificial de Python.

• Si ya tienes python instalado, puedes revisar su versión con el comando en la cmd:

Python --version

2. WSL (linux subsystem for windows):

Para levantar la API necesitamos Docker y para instalar Docker necesitamos WSL ya que es la configuración recomendada al instalar Docker.

• WSL se instala con el siguiente comando en PowerShell (Administrador):

wsl --install

• Si ya tienes WSL, puedes verificar su versión con ( Versión 2 Recomendada):

wsl -l -v

• Si la versión es antigua puedes actualizar con el siguiente comando:

wsl --update

NOTA: Con Docker puede que aparezca un error de "An unexpected error was encountered while executing a WSL command". Esto ocurre intentar usar Docker en las versiones actuales de Windows, para corregir este problema debes: activar en la BIOS el SVM mode**. Con esto debería funcionar con normalidad cualquier instalación de Docker en Windows, ya que con esa opción se activa la virtualización en el equipo.

3. Docker:

Para levantar la API necesitaremos Docker Desktop. El instalador se puede descargar desde su pagina oficial: Docker.com

Instrucciones de uso:

Para poder levantar esta API y consumirla es necesario cumplir con los prerrequisitos para proceder a instalar las dependencias y correr el código fuente.

1. Abrir entorno virtual de Python:

Para instalar las dependencias y levantar nuestra API necesitamos abrir un entorno virtual de Python.

• Esto se puede hacer abriendo el archivo: "activar-venv.bat".
• Si deseas cerrar el entorno virtual puedes tabular dentro de la cmd el comando:

desactivar-venv.bat

2. Instalar dependencias:

Para que todo funcione, la API y Docker necesitan algunas bibliotecas las cuales se pueden instalar con esta linea de comandos:

pip install -r requirements.txt

3. Levantar API con Docker:

Para poder levantar la API como servidor debemos encapsularla en un contenedor con Docker, esto se hace corriendo el "Dockerfile" con comandos.

Para hacer esto mas fácil, puedes usar esta linea de comandos ya preparada:

levantar-docker.bat

NOTA: Debe estar abierto el "Docker Desktop" para levantar la API con el contenedor.

4. Consumir API:

Para consumir la api, basta con abrir el "index.html" del prototipo con un navegador (ej. Chrome) y visualizar si muestra los médicos. Desde la consola del entorno virtual se puede observar si se están haciendo las consultas HTTP a la API.

NOTA: La API será consumida a través de un JavaScript la cual tiene los métodos de consulta a la dirección donde esta alojada la API. ej. "http://localhost:5000/".