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

1. Crear una cuenta en https://www.heroku.com/

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

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

Para probar el back se requiere instalar Postman el cual lo puede descargar de https://www.postman.com/

Deberá crear una cuenta gratuita en https://signup.heroku.com/ con sus datos personales

1. Abra una nueva pestaña y acceda a https://github.com/MISW-4104-Web/BackVynils/tree/heroku-integration
2. Haga click en el botón "Deploy to Heroku"

3. Presione el botón "Deploy app" y espere a que se genere la URL de su proyecto. Solo necesitarán una URL del proyecto desplegado por equipo.

4. Al final debe aparecer el siguiente mensaje:

5. Haga clic en el botón View y recuerde la URL que se generó. Esta será la URL base para hacer las peticiones al back.

Para probar las colecciones y verificar que el back funciona correctamente se deben realizar los siguientes pasos:

Clone el siguiente repositorio:

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

Abra Postman y vaya a al menú File > Import > Folder

Haga clic en "Choose folder from your computer" y en el directorio donde clonó el back seleccione la carpeta "collections"

Luego de esto deben aparecer 15 colecciones disponibles y dos entornos

Haga clic en el botón "Import".

En la parte superior derecha de Postman seleccione el entorno denominado "Entorno Colecciones Vynyl - Heroku".

Luego haga clic en el ícono "Environment quick look" (el que tiene forma de ojo) y edite el valor para la variable denominada ip.

En INITIAL VALUE y en CURRENT VALUE ingrese la URL que se generó cuando se hizo el despliegue del back en Heroku.

Finalmente, seleccione cada colección y ejecútela haciendo clic en el botón Run

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