Contenido del curso
Creación de Recursos en Laravel para Formato Personalizado de Datos
¿Cómo mejorar el formato de los recursos en una API?
Desarrollar una API no se trata solo de conectar y obtener datos, sino de presentarlos de manera organizada y comprensible. En este contexto, aprender a utilizar recursos para mejorar el formato de los datos es crucial. A continuación, veremos cómo crear y configurar una clase de recurso en Laravel para lograr un diseño más intuitivo y fácil de consumir por aplicaciones externas.
¿Cómo crear una clase de recurso en Laravel?
Para mejorar la presentación de los datos, se puede utilizar una clase de recurso en Laravel que permite definir un formato específico.
La clase se denominaphp artisan make:resource BunoPostResource
BunoPostResource. Observa que "Buno" indica la versión uno de la API (abreviada como "buno"). Aunque no tengamos planificada una versión dos, estipulamos este prefijo anticipándonos a futuras expansiones.¿Cómo configuro la estructura del recurso?
El objetivo es dar formato a los datos que estamos obteniendo de nuestra base de datos y que se visualizan en Postman o se entregan a otros servicios.
HTTP en nuestro proyecto. Solo es necesario cambiar la información que queremos mostrar:
public function toArray($request) { return [ 'title' => $this->title, 'slug' => $this->slug, 'excerpt' => $this->excerpt, 'content' => $this->content, ]; }
En este caso, solo mostramos los campos title, slug, excerpt y content. Estos campos se extraerán, algunos de manera directa y otros como campos virtuales, del modelo Post.
¿Cómo se implementa el recurso en el controlador?
Después de definir el recurso, es necesario integrarlo en el controlador correspondiente para que se use a la hora de devolver datos.
Configurar el controlador:
PostController.use App\Http\Resources\BunoPostResource;
Utilizar el recurso en el método del controlador:
return new BunoPostResource($post);
¿Qué beneficios ofrece el uso de recursos en una API?
El uso de recursos forma parte del proceso para ofrecer APIs más limpias, mantenibles y flexibles.
En resumen, para perfeccionar la experiencia de los usuarios al interactuar con una API, es vital prestar atención al formato de los datos y cómo estos se presentan, asegurando así una arquitectura sólida y preparada para el crecimiento.
IRIDIAN GUADALUPE CARRERA MONDRAGÓN
Estudiante
Mariano Gastón Paduani
Estudiante
Carlos Eduardo Gomez García
ProfesorMariano Gastón Paduani
Estudiante
Konny Amaya
Estudiante
Jimmy Buriticá Londoño
Estudiante
William Condori
Estudiante
Walter Omar Barrios Vazquez
Estudiante
Renzo Martín Staiti
Estudiante
Añaqui Apolinar Morales
Estudiante
Italo Morales Fantone
Profesor
Sebastian Domingo Villar Segura
Estudiante
Gilber Alzate
Estudiante
Rodolfo Rohatan Bassil
EstudianteGilber Alzate
EstudianteVersión 1: recurso
Obtener el recurso con un mejor formato, esto va a crear una carpeta: en terminal hacemos lo siguiente:
php artisan make:resource V1/PostResource
nos dirigimos al archivo creado dentro de app > Http > resources > PostResource.php así quedaria:
<?php namespace App\Http\Resources\V1; use Illuminate\Http\Resources\Json\JsonResource; class PostResource extends JsonResource { /** * Transform the resource into an array. * * @param \Illuminate\Http\Request $request * @return array */ public function toArray($request) { return [ 'title' => $this->title, 'slug' => $this->slug, 'excerpt' => $this->excerpt, 'content' => $this->content ]; } }
en PostController.php vamos a retornar ese recurso que estamos utilizando. agregamos lo siguiente:
use App\Http\Resources\V1\PostResource;
public function show(Post $post) { return new PostResource($post); }
Esto Funciona de la siguiente manera: Tenemos una ruta la ruta dispara un controlador el controlador tiene dentro e si una acción esta acción retorna ese recurso y eso es lo que le mostramos al usuario o al software que se vaya a conectar a nuestra aplicación.
Gracias!
En el Curso Avanzado de Laravel se explican un poco más detallado las rutas de recursos dentro de Laravel, en específico en esta clase, aquí el profesor hace ejemplos de cómo personalizar lo que el API devuelve usando los Resources de Laravel 👀: . https://platzi.com/clases/1959-laravel-avanzado/30083-capa-de-transformacion-con-api-resources/
Aunque, no vayan con muchas expectativas a ese curso jajaja
yo quiero hacer el de Laravel avanzado, en su opinion companeros, que tan bueno es?
Eloquent: API Resources Cuando se construye una API, se puede necesitar una capa de transformación entre el Modelo Eloquent y la respuesta JSON. En esta capa de Recursos se pueden limitar la cantidad de campos del registro y mejorar la presentación de los mismos. Documentación
Remover el key data de la respuesta
Si no les gusta el key data que se agrega automáticamente, pueden quitarlo agregando la siguiente propiedad a su Resource
public static $wrap = null;
wrap = envoltura 😉
EN SI, ESTA BIEN LO QUE ESTA EPLICANDO EL PROFESOR, PERO NO SE ACOSTUMBREN A USAR EL RECURSO PARA FILTRAR QUE CAMPOS MOSTRAMOS Y CUAL NO. ESO SE TIENE QUE HACER EN EL MODELO, NO SE TRAIGAN EN EL SELECT COLUMNAS QUE NO VAN A USAR, ESOS SON RECURSOS QUE SERVIDOR DE BASE DE DATOS ESTA USANDO AL PEDO.
YA DESDE EL MODELO SEPAN QUE VAN A USAR Y QUE NO.
Orale, no conocia los resource de laravel para apis. Me pregunto cuantas formas de uso tienen? (Comenten su codigo de como lo usan)
Son cosas que sorprenden de Laravel :)
En pocas palabras este capitulo describe un DTO.
Si tienen problemas al consultar los datos en la versión actual de Laravel y no están seguros de qué se debe enviar a PostResource, recuerden que se trata de la variable que contiene los datos resultantes de la consulta. En el ejemplo, esta variable es $post.
public function show($id)
{
$post = Post::find($id);
return new V1PostResource($post);
}
de donde sale excerpt si no existe como campo en la base de datos.
en el video anterior explican que es un comando custon de laravel y se ancla de los detalles