¿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:

1. Manejo básico de Github.
2. 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 Figura 1 representa el modelo de datos del API REST:

Figura 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.

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

Para ejecutar el back en su equipo local, instale las herramientas que se mencionan en la Tabla 1. Las versiones indicadas son las usadas al momento de realizar este tutorial.

Tabla 1. Herramientas necesarias para ejecutar el back

Una vez instalada la base de datos, inicie el programa pgAdmin que viene incluido en la instalación de PostgreSQL. Esto abrirá una nueva pestaña en el navegador por defecto con la dirección http://127.0.0.1:57193

En la parte izquierda de la pantalla despliegue la opción Servers > PostgreSQL > Databases (ver Figura 2).

Figura 2. Vista principal de pgAdmin.

Haga clic derecho sobre el nodo Databases y seleccione la opción Create > Database y cree una nueva base de datos con el nombre vinyls.

Desde la línea de comandos clone el repositorio que contiene el código de back:

git clone https://github.com/MISW-4104-Web/BackVynils.git 

Ingrese a la carpeta del proyecto y edite el archivo ormconfig.json. Verifique que los valores para "username" y "password" corresponden con los de su instalación de postgres. Guarde los cambios.

Luego, desde la línea de comandos ingrese a la carpeta donde clonó el repositorio e instale las dependencias con el comando:

npm install

Luego ejecute:

npm run start

Esto iniciará un servidor web que escucha peticiones 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 y dos entornos (ver Figura 3).

Figura 3. Vista de las colecciones luego de importarlas

Haga clic en el botón Import.

En la parte derecha de Postman seleccione el entorno denominado "Entorno Colecciones Vynil - Equipo Propio" (ver Imagen 4). Esto permitirá que los request de las colecciones se hagan al servidor "localhost" en el puerto 3000.

Figura 4. Selección del entorno.

Seleccione cada colección y ejecútela haciendo clic en el botón Run (ver Figura 5).

Figura 5. Vista de las colecciones para ejecutar en Postman

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