Consultas API con Laravel: Rutas y Controladores

Curso de Estándares y Buenas Prácticas para API REST con Laravel

Contenido del curso

Buenas prácticas a nivel general

Creación del proyecto

Planificación y mantenimiento

Funciones de seguridad

API Testing

API Breaking Changes

Conclusiones

Tomar examen

Cursos Empresas Blog Live Conf Eventos Precios

0:0014:14

Consultas API con Laravel: Rutas y Controladores

Curso de Estándares y Buenas Prácticas para API REST con Laravel

Clase 6 de 29

Clase 6 / 29

Recursos

¿Cómo configurar controladores y rutas en Laravel para una API?

Para construir una API eficiente y bien organizada en Laravel, es fundamental entender cómo configurar tanto los controladores como las rutas. Este proceso es esencial para gestionar adecuadamente las consultas a nuestra base de datos. A continuación, te mostramos cómo hacerlo paso a paso.

¿Cómo crear un controlador API en Laravel?

Comenzamos creando controladores específicos para nuestra API en Laravel, lo cual ayuda a segmentar y organizar el código de manera profesional. Aquí te mostramos cómo hacerlo:

Abrir el terminal en VS Code: Esto te permitirá ejecutar comandos de Artisan.
Crear el controlador usando Artisan:
```
php artisan make:controller API/CategoryController
```
- Este comando crea una carpeta API y dentro de ella CategoryController.
Repetir el proceso para otros controladores:
- Crea controllers para recetas y etiquetas siguiendo los mismos pasos.
```
php artisan make:controller API/RecipeController
php artisan make:controller API/TagController
```

¿Cómo configurar rutas para una API en Laravel?

Una vez que los controladores están listos, es momento de configurar las rutas para que nuestras API puedan ser accedidas correctamente.

Acceder al archivo de rutas API: Navega hasta el archivo de rutas específico para API (routes/api.php).

Configurar rutas utilizando métodos HTTP:

Por ejemplo, para obtener todas las categorías:

Route::get('categories', [CategoryController::class, 'index']);

Para obtener una categoría específica:

Route::get('categories/{category}', [CategoryController::class, 'show']);

Importar controladores necesarios: Asegúrate de importar correctamente los controladores usando use.

¿Cómo verificar la configuración de rutas?

Es importante comprobar que nuestras rutas están configuradas correctamente. Puedes hacerlo directamente desde el terminal con un comando Artisan.

Ejecutar comando en terminal:
```
php artisan route:list --path=api
```
- Este comando muestra todas las rutas configuradas para la API.

¿Cómo trabajar con controladores para gestionar las consultas?

Los controladores son el núcleo que permite realizar consultas a base de datos:

Método Index para obtener todas las categorías:
- En CategoryController, define el método index:
```
public function index() {
    return Category::all();
}
```

Método Show para una categoría específica:

public function show(Category $category) {
    return $category;
}

Hacer lo mismo para recetas y etiquetas:
- Modifica los controladores correspondientes para trabajar con Recipe y Tag.

¿Cómo probar las APIs de Laravel?

Para garantizar que los endpoints funcionan correctamente, es recomendable utilizar herramientas profesionales:

Utilizar Postman:
- Enviar peticiones: Configura el endpoint en Postman para enviar peticiones GET a tu API.
- Verificar respuestas: Comprueba que las respuestas sean correctas y que reflejen la estructura de los datos que esperas.

¿Por qué usar Postman?

Postman es esencial para evaluar APIs porque:

Guarda tu historial de consultas.
Muestra el estado de la respuesta inmediatamente.
Facilita el manejo de diferentes métodos y recursos HTTP de manera ordenada.

Realizar estas configuraciones básicas y pruebas es crucial para asegurar que tu API de Laravel está funcionando de manera eficiente y ordenada, permitiendo que las interacciones con la base de datos sean rápidas y claras. Continúa explorando y mejorando tus habilidades con Laravel para construir aplicaciones web robustas y escalables.

Santiago Velásquez Serna

Hace 3 años

Es buena practica tambien asignar una versión para la api para que cuando haya una nueva versión, tus usuarios puedan seguir utilizando la vieja mientras aprenden a usar la nueva, esto se puede hacer de varias maneras, pero en este caso yo utilice el metodo prefix .

Ademas podemos hacer uso de apiResource que nos trae los 5 metodos de una api(index, store, show, update, destroy ) y si lo queremos podemos trabajar solo con algunos con el metodo only.

Ahora bien, si tenemos varias rutas que tienen una configuración en común podemos hacer grupos. En este caso todas van a pertenecer a la version 1 y probablemente mas adelante le agreguemos un middleware de autenticación. Esto lo logramos con el metodo group.

Dejo mi codigo de ejemplo

Route::prefix("V1")->groups(function () {
    Route::apiResource("categories", CategoryController::class)->only(["index", "show"]);
    Route::apiResource("recipes", RecipeController::class)->only(["index", "show"]);
    Route::apiResource("tags", TagController::class)->only(["index", "show"]);
});

Kenneth Angulo L

Hace 2 años

Gracias por el aporte companero. Usando el metodo group() y ademas apiResource compacta au mas el codigo y nos permite mas orden.

Buena solucion lo del prefijo 'V1' en las rutas, aclarar que este versionamiento tambien debe ser aplicado a los namespaces porque de lo contrario siempre estaras apuntando al mismo controlador por mas que la ruta cambie.

Es decir:

Http/Controllers/Api/V1/RecipesController.php

Comentarios (12)12 comentarios

José Jesús Palacios

German Ernesto Felipe Perez Lerma

Juan Pablo Campuzano Monsalve

Camilo Venegas

Hace 7 meses

Carlos Ugarte

Hace un año

Oscar Monsalve

John Ortiz

Johann Enrique Hurtado Salas

Guillermo Mata

Daniel Yepes

Iván Roberto Rivas Celeita

Gilberto Pérez Garrido

MCETS DEV

Martin Campos

Manuel Gerardo Flores Quiñonez

Buenas prácticas a nivel general

Buenas prácticas para diseñar una API REST

¿Qué son los HTTP Status Codes?

Qué hace cada método HTTP

Creación del proyecto

Migrações e relações de dados em Laravel

Factories y seeders para poblar tu API en Laravel

Consultas API con Laravel: Rutas y Controladores

Consultas con relaciones en Laravel API

Planificación y mantenimiento

Planificación de rutas REST en Laravel

Recursos y colecciones en Laravel API

Recursos anidados en Laravel API

Cómo reducir 932 consultas con Telescope

CRUD de Recetas con Laravel y Symfony en Visual Studio Code

Validación de Datos en Aplicaciones Web con Laravel

Funciones de seguridad

Autenticación vs. autorización

Proteger rutas de API con Sanctum

Ruta de login y tokens con Sanctum

Corrección de bugs de seguridad en aplicaciones web

Políticas de acceso en Laravel con Artisan

Upload e validação de imagens em Laravel

Qué es autenticación en la web

API Testing

Automatiza pruebas de API en Laravel

Testing de Módulos Administrativos en Visual Studio Code

Testing de recetas con PHP Artisan

Pruebas de Creación de Datos en Aplicaciones Web

Test de actualización de recetas en Laravel

API Breaking Changes

Versionado de API en Laravel con v1 y v2

Desarrollo de API con TDD: Implementación de Versión 2

Conclusiones

Desarrollo de API RESTful con Laravel: Buenas Prácticas y Seguridad

Buenas prácticas finales para tu API en Laravel

Consultas API con Laravel: Rutas y Controladores