Práctica: Creación de una API REST para Products

Objetivo de la actividad

Actividad en el aula virtual

En esta práctica vas a aplicar todo lo aprendido sobre Laravel y la creación de APIs REST para desarrollar un servicio completo que gestione productos (Products). Al finalizar, habrás implementado todos los elementos esenciales de una API moderna:

Definición de rutas API (api.php)
Creación de un controlador con métodos CRUD (index, show, store, update, destroy)
Uso de modelos y migraciones
Validación de datos mediante Form Request
Personalización de la salida con API Resources
Pruebas de los endpoints con Postman o REST Client

Este ejercicio te permitirá consolidar los conceptos vistos con el recurso Note y demostrar que puedes aplicarlos de forma autónoma en un nuevo caso.

Instrucciones

Sigue los pasos en orden, comprobando el funcionamiento de cada parte antes de pasar a la siguiente. Puedes basarte en el ejemplo del tema anterior sobre Notes, adaptándolo al nuevo recurso Product. O continuar con el proyecto de las prácticas anteriores que ya trata sobre productos.

1. Preparar el entorno

Abre el proyecto de Laravel que has elegido.
Asegúrate de tener las rutas API activadas. Si no lo hiciste antes, ejecuta:
```
php artisan install:api
```
Verifica que los contenedores de Docker estén funcionando:
```
docker compose up -d
```

2. Crear la tabla y el modelo de productos

Si no tienes ya una tabla products, crea una nueva migración y el modelo asociado. Si ya lo tienes continúa con el siguiente paso.

Genera la migración para la tabla products:

php artisan make:migration create_products_table

2. Edita la migración para que incluya los siguientes campos:

$table->id();
$table->string('name');
$table->text('description')->nullable();
$table->decimal('price', 8, 2);
$table->integer('stock');
$table->timestamps();

3. Ejecuta las migraciones:

php artisan migrate

4. Crea el modelo Product:

php artisan make:model Product

5. Define en el modelo los campos permitidos para asignación masiva:

protected $fillable = ['name', 'description', 'price', 'stock'];

3. Crear el controlador API

Crea el controlador ProductController en el espacio de nombres api.
Implementa en él los cinco métodos principales (index, store, show, update, destroy) para manejar el CRUD. Puedes basarte en el ejemplo del recurso Note del tema.

4. Definir las rutas

Crea las rutas para manejar los productos, utiliza apiResource:

Comprueba que se hayan creado las rutas con:

php artisan route:list --path=api/products

5. Crear el API Resource

Genera la clase ProductResource. Esta clase te permitirá personalizar la estructura de los datos JSON que devuelve la API. Un ejemplo de estructura sería:

``json { "id": 1, "nombre": "Camiseta", "precio": "$19.99", "stock": 25, "descripcion": "Camiseta de algodón" } ``` 2. Usa esta clase en el controlador para las respuestas JSON.

6. Validar los datos con una clase Form Request

Crea la clase ProductRequest para validar los datos de entrada al crear o actualizar un producto. Las reglas de validación podrían ser:
- name: obligatorio, cadena de texto, mínimo 3 y máximo 255 caracteres
- description: obligatorio, cadena de texto, mínimo 10 caracteres
- price: obligatorio, numérico, mínimo 0, máximo 9999.99
- stock: obligatorio, entero, mínimo 0, máximo 10000
`` 2. Modifica los métodosstore()yupdate()` del controlador para usar esta clase:

7. Probar la API

Crea un archivo products.rest en la raíz del proyecto (o usa Postman).
Escribe las peticiones para probar todos los endpoints:
- GET /api/products → Listar todos los productos
- POST /api/products → Crear un nuevo producto
- GET /api/products/{id} → Mostrar un producto
- PUT /api/products/{id} → Modificar un producto
- DELETE /api/products/{id} → Eliminar un producto
Comprueba que todas las operaciones devuelven los códigos HTTP correctos (200, 201, 204, etc.) y que la respuesta JSON tiene el formato definido en ProductResource.

Entrega

Crea un pdf con los siguientes contenidos:

Capturas de las peticiones y respuestas en REST Client, o la extensión que utilices
Un breve archivo README.md explicando las rutas y cómo probarlas
Añade al pdf el código de la migración, el modelo, el controlador, la clase Resource y la clase Request

Rúbrica de evaluación

Criterio	Descripción	Peso
Estructura del proyecto y rutas	Configura correctamente las rutas API y el controlador con los métodos CRUD.	15 %
Migración y modelo	La tabla y el modelo `Product` están correctamente definidos y funcionales.	20 %
Validación de datos	Implementa correctamente `ProductRequest` y usa `$request->validated()` en lugar de `$request->all()`.	20 %
Formato de salida (Resource)	Devuelve las respuestas formateadas correctamente usando `ProductResource`.	20 %
Pruebas y funcionamiento general	Todas las operaciones CRUD funcionan y devuelven los códigos HTTP adecuados.	25 %

Total: 100 %