Generando rutas REST con blueprint

¿Qué es el Blueprint Happy en el framework Seis?

El Blueprint Happy es uno de los comandos más potentes de Seis, un framework que permite generar una variedad significativa de funcionalidades sin necesidad de escribir ni una sola línea de código. Con este comando, se puede crear un modelo de objeto que se manipula a través de los verbos comunes de HTTP. Estos incluyen operaciones como crear, actualizar, eliminar y otras funciones, como la búsqueda.

¿Cómo se genera un Blueprint Happy?

Para iniciar, nos desplazamos a la consola de comandos. Si la aplicación está corriendo, se recomienda cerrarla con Control + L. Posteriormente, ejecutamos el siguiente comando para generar el Blueprint Happy:

six push generate api

Al realizar esto, se creará automáticamente un nuevo archivo de controlador y un modelo. La estructura es sencilla, pero aún sin líneas de código visibles, el framework gestiona mucha funcionalidad interna que será aprovechada posteriormente.

¿Cómo configurar y utilizar Postman para pruebas?

Posteriormente, configuraremos un cliente HTTP para probar el servicio, en este caso usaremos Postman:

1. Crear una colección:

   • Una colección en Postman es como una carpeta para almacenar las solicitudes HTTP que se van a hacer a un servidor.
   • Ejemplo: Crear la colección llamada "PlatziRight".

2. Adicionar solicitudes:

   • Obtener datos (GET): Para obtener registros de Ride.

     HTTP
     URL: http://localhost:1337/api/rides
     Método: GET
     

   • Crear datos (POST): Para guardar un nuevo registro en Ride.

     HTTP
     URL: http://localhost:1337/api/rides
     Método: POST
     Cuerpo: Form-Data (ej. `name`, `startDate`, `endDate`)
     

El método GET se utiliza para obtener recursos de la base de datos, y el POST para guardarlos.

¿Dónde se guarda la información por defecto?

Una duda común es dónde se almacenan estos datos. La información de manera predeterminada se guarda en un archivo local de texto. En el proyecto, se puede encontrar dentro de la carpeta .tmp/localDiskDb. Ahí se pueden visualizar los registros creados durante las pruebas.

Seis procesa todas las llamadas, agrega identificadores y los guarda automáticamente en este archivo de base de datos por defecto.

Prácticas y recomendaciones al trabajar con Seis y Postman

• Utilizar correctamente Postman: Asegúrate de realizar pruebas completas; puedes duplicar solicitudes, modificar rápidamente los datos y observar las respuestas recibidas.
• Validar datos almacenados: Aunque los registros por defecto se guardan en archivos locales, en futuras clases se profundizará en cómo almacenar datos en una base de datos estructurada.
• Mantener la estructura de proyectos: Asegura una correcta organización de archivos y carpetas para facilitar la gestión y comprensión del código.

Con estos pasos, estás bien equipado para crear y manipular un API de manera efectiva utilizando el Blueprint Happy en Seis. ¡Sigue aprendiendo y experimentando para dominar este potente framework!