Ejecutando comandos desde la API

Contenido del curso

Laravel y Base de Datos

Entorno de trabajo y repaso de Laravel

Manejo de tu base de datos con Laravel

La terminal de Laravel

Eventos y tareas de Laravel

Manejo de errores

El corazón de Laravel

Creación de paquetes

Tomar examen

Cursos Empresas Blog Live Conf Eventos Precios

0:003:15

Ejecutando comandos desde la API

Curso Avanzado de Laravel

Clase 11 de 33

Clase 11 / 33

Recursos

Integrar la ejecución de comandos directamente desde un controlador es una técnica poderosa en Laravel que permite automatizar tareas programadas a través de endpoints HTTP. Esto abre la puerta a disparar procesos como el envío masivo de correos desde una simple petición a tu API, sin necesidad de ejecutar comandos manualmente en la terminal.

¿Cómo ejecutar un comando Artisan desde un controlador?

El primer paso es crear o utilizar un controlador existente. En este caso se trabaja con un Newsletter Controller [0:25]. Dentro de este controlador se declara un método llamado send, cuya responsabilidad es invocar un comando Artisan desde la aplicación.

La clave está en utilizar la facade Artisan y su método call [0:43]. Este método recibe como parámetro el nombre del comando que deseas ejecutar. Por ejemplo, para llamar al comando de envío de verificación de correo electrónico:

php use Illuminate\Support\Facades\Artisan;

public function send() { Artisan::call('send:email-verification --class');

$data = ['message' => 'Todo okay'];
return response()->json($data);

}

El método Artisan::call() permite ejecutar cualquier comando registrado en tu aplicación, incluyendo los que hayas creado de forma personalizada. Después de la ejecución, se retorna una respuesta en JSON confirmando que el proceso se completó correctamente.

¿Cómo configurar la ruta para el endpoint?

Una vez listo el controlador, es necesario apuntar una ruta hacia ese método. Dentro del archivo api.php se declara una ruta de tipo POST [1:10]:

php Route::post('/newsletter', [NewsletterController::class, 'send']);

Esta ruta responde a peticiones POST en la dirección api/newsletter y ejecuta el método send del controlador.

¿Cómo preparar la base de datos para probar el envío?

El comando utilizado verifica en la base de datos usuarios que se hayan creado hace siete días y que además no hayan verificado su correo electrónico [1:18]. Para simular este escenario es necesario:

Ubicar un registro de usuario en la base de datos.
Colocar el campo email_verified_at en nulo.
Ajustar la fecha de creación a siete días antes de la fecha actual.

Con estos datos preparados, el comando encontrará al usuario y le enviará el correo de verificación.

¿Cómo verificar que el correo fue enviado correctamente?

Desde un cliente HTTP como Postman o Insomnia, se envía una petición POST a la ruta api/newsletter [1:42]. Si la respuesta devuelve un código 200, significa que el proceso se ejecutó sin errores.

Para confirmar que el correo llegó, basta con revisar el servidor SMTP configurado, como Mailtrap [1:52]. Ahí se puede visualizar el correo de verificación recibido.

¿Qué más puedes construir con esta técnica?

Esta misma estrategia de llamar comandos desde controladores se puede aplicar a múltiples escenarios dentro de una API. El reto propuesto consiste en crear dos endpoints adicionales [2:03]:

Uno para calificar usuarios.
Otro para calificar productos.

Ambos deben seguir la misma lógica: un controlador que reciba la petición, ejecute la lógica necesaria y devuelva una respuesta apropiada. Esta práctica refuerza la capacidad de reutilizar comandos Artisan como servicios accesibles desde cualquier parte de tu aplicación, no solo desde la línea de comandos.

¿Ya implementaste tus propios comandos personalizados y los llamaste desde un endpoint? Comparte tu experiencia y las variantes que encontraste en los comentarios.

Brian Sánchez Izquierdo

Hace 6 años

Hola, les dejo mi solución al reto para calificar productos desde un EndPoint. . Primer parte - Prueba Siguiendo TDD, primero se escribe una prueba, la mía es medio escueta en la respuesta pero fuerte en la comprobación de la DB:

<?php

namespace Tests\Feature\Http\Controllers;

use App\Models\Product;
use App\Models\User;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithFaker;
use Tests\TestCase;

class RatingControllerTest extends TestCase
{
    use RefreshDatabase;
    /**
     * Pruebo un End-Point de mi API que me permita calificar un producto
     *
     * @return void
     */
    public function test_api_product_rating()
    {
        $this->withoutExceptionHandling();
        $user = User::factory()->create();
        $product = Product::factory()->create();
        $data = [
            'score' => 3.5
        ];

        $this
            ->actingAs( $user )
            ->postJson( "api/rating/products/$product->id", $data );

        $this
            ->assertDatabaseHas( 'ratings', [
                'score' => $data['score'],
                'rateable_type' => get_class($product),
                'rateable_id' => $product->id,
                'qualifier_type' => get_class( $user ),
                'qualifier_id' => $user->id
            ] );
    }
}

Básicamente, creo un usuario, luego un producto y luego la información que se enviará en la solicitud API - después actuando como el usuario recien creado publico en el endpoint indicado mi data para luego comprobar que en efecto se creó el registro de la calificación en la tabla ratings. Les dejo el commit en mi repositorio: Pruebo que un usuario pueda calificar un producto desde un EndPoint API . Segunda parte - Api route Para hacer que la prueba pase hay que decirle a Laravel que en efecto existe el endpoint al que queremos pasarle la calificación y lo hacemos de la siguiente forma:


Route::post( 'rating/products/{product}', [App\Http\Controllers\RatingController::class, 'products'] )
            ->middleware('auth:sanctum');

Aquí decimos que cuando se acceda a la ruta especificada se ejecute el método products del RatingController ( aún no creado), les dejo el commit en mi repositorio: End Point protejido por sanctum para calificar producto . Tercera parte - Método Products de RatingController Ahora sí se viene lo bueno (xd), creamos el controlador que indicamos en la ruta (php artisan make:controller RatingController) y definimos lo que el método products deba hacer:


<?php

namespace App\Http\Controllers;

use App\Models\Product;
use Illuminate\Http\Request;

class RatingController extends Controller
{
    public function products( Request $request, Product $product )
    {
        $request->user()->rate( $product, $request->score );

        return response()->json([
            'data' => 'califición aplicada'
        ]);
    }
}

Aquí accedemos al usuario mediante el obejto $request y encadenamos el método rate() para pasarle el $product a calificar y el score del $request y respondemos que todo ok. Les dejo el commit de mi repositorio: método products de RatingController

y ya está! la prueba pasa 🥳

Comentarios (18)18 comentarios

Tomas Goldenberg

Jimmy Buriticá Londoño

Sergio Eduardo Mosquera Villegas

Pablo Andrés Pineda Granada

Hace 5 años

Mariano Gastón Paduani

Carlos Eduardo Gomez García

Horacio Degiorgi

Fernando Mejia

Alan Christian Ruiz Aguirre

Deivis Andrés Cervantes

Hace 3 años

Miguel Angel Muñoz Pozos

Jean Nuñez

Nixon Ivan Torres Torrealba

Juan David Rueda Quiroga

Kenneth Angulo L

Hace 2 años

Juan Guillermo Perez Cardozo

Josafat Morales Toledo

Regynald Zambrano

Cristian Johany Devia Hormaza

Cristhian Coaquira

Laravel y Base de Datos

Entorno de trabajo y repaso de Laravel

Qué aprenderás sobre Laravel Avanzado

Instalación de Laravel con Composer

Configuración SQLite y API productos Laravel

Instalación, configuración y uso de Homestead

Instalar Laravel Sanctum

Tipos de autenticación en Laravel

Manejo de tu base de datos con Laravel

API Resource Laravel para JSON preciso

Manejo de relaciones en bases de datos con Laravel

Cómo usar relaciones polimórficas en Laravel

La terminal de Laravel

Comandos personalizados en Laravel con Artisan

Ejecutando comandos desde la API

Programación de tareas

Eventos y tareas de Laravel

Eventos y Listeners en Laravel

Eventos de Eloquent

Queues y jobs en Laravel con driver database

Listeners a jobs con JobQueue en Laravel

Laravel Horizon

Manejo de errores

Cómo capturar y leer errores con la clase Handler

Excepciones personalizadas

Manejo de excepciones HTTP con abort en Laravel

Configuración de logs y channels en Laravel

El corazón de Laravel

Ciclo de vida de una aplicación en Laravel

Qué es el service container de Laravel

¿Cómo funciona un service container?

Service providers: cargar componentes sin instanciar

Creación de paquetes

Cómo crear paquetes Laravel con Composer

Propiedades para manejo de dependencias

Comprende el archivo composer.json

Cómo Composer carga clases automáticamente

Crear mis propios Services Providers

Cómo publicar archivos con Service Provider

Instalando paquetes desde GitHub con Composer

Publicar tu paquete PHP en Packages

Ejecutando comandos desde la API