Tutorial API REST (Docker)

¿Qué aprenderá?

Al finalizar este tutorial el estudiante estará en capacidad de usar el API REST que se provee como base para el desarrollo del proyecto del curso.

¿Qué obtendrá?

Las herramientas necesarias para el uso del API REST.

¿Qué necesita?

Es necesario que tenga:

Manejo de consola de comandos.

¿Cómo está estructurado este documento?

En las siguientes dos primeras secciones encontrará el modelo de datos del back junto con la documentación de los servicios. Posteriormente se detallan los pasos del tutorial.

La imagen a continuación representa el modelo de datos del API REST:

Imagen 1. Modelo de datos del API REST

En los enlaces que se presentan a continuación está la documentación de los servicios provistos por el API.

Servicio	URL
Álbum	https://documenter.getpostman.com/view/8840688/SzmZd1L6
Álbum Banda	https://documenter.getpostman.com/view/8840688/SzmZd1QV
Álbum Músico	https://documenter.getpostman.com/view/8840688/SzmZd1QW
Banda	https://documenter.getpostman.com/view/8840688/SzmZd1Us
Banda Álbum	https://documenter.getpostman.com/view/8840688/SzmZd1Ut
Banda Músico	https://documenter.getpostman.com/view/8840688/SzmZd1Uu
Coleccionista	https://documenter.getpostman.com/view/8840688/SzmZd1Ux
Coleccionista Álbum	https://documenter.getpostman.com/view/8840688/SzmZd1Uy
Coleccionista Artista	https://documenter.getpostman.com/view/8840688/SzmZd1Uz
Comentarios	https://documenter.getpostman.com/view/8840688/SzmZd1V1
Músico	https://documenter.getpostman.com/view/8840688/SzmZd1ZH
Músico Álbum	https://documenter.getpostman.com/view/8840688/SzmZd1ZK
Artista Premio	https://documenter.getpostman.com/view/8840688/SzmZd1ZL
Premio	https://documenter.getpostman.com/view/8840688/SzmZd1ZM
Tracks	https://documenter.getpostman.com/view/8840688/SzmZd1ZN

Tabla 1. Enlaces a la documentación de los servicios

Para ejecutar el back en su equipo local deberá descargar Docker

Nombre	Descripción	Versión	URL
Docker	Plataforma de contenedores	19	https://www.docker.com/products/docker-desktop
Postman	Herramienta para crear peticiones a APIs y para elaborar tests para validar el comportamiento de una API	7.25	https://www.postman.com/

Tabla 2. Herramientas necesarias para ejecutar el back

Instale Docker siguiendo el enlace de su sistema operativo https://www.docker.com/products/docker-desktop

Si su sistema operativo no permite instalar Docker (e.g, Windows 10 Home) deberá seguir pasos adicionales para ejecutar el proyecto: https://misovirtual.virtual.uniandes.edu.co/codelabs/APIREST/index.html#3

Descargue el archivo de docker-compose: Archivo . El archivo debe tener el nombre docker-compose.yml
Ejecute el comando docker-compose up en la carpeta donde se encuentre el archivo
Después de unos minutos, Docker habrá descargado automáticamente todas las dependencias del proyecto y lo ejecutará en el puerto 3000.

Para probar las colecciones y verificar que el back se está ejecutando correctamente debe abrir Postman e importar las colecciones que se encuentran en el directorio donde se clonó el back en la carpeta collections.

Luego de esto deben aparecer 15 colecciones disponibles.

Imagen 3. Vista de las colecciones luego de importarlas

Seleccione cada colección y ejecútela haciendo clic en el botón Run:

Imagen 4. Vista de las colecciones para ejecutar en Postman

Si las colecciones se ejecutan sin error es porque todo quedó configurado correctamente.