VorStart-API-Routenereignis

„BeforeStartApiRouteEvent“ wird ausgelöst, während NexoPOS mit dem Laden der API-Routen beginnt. Module können es verwenden, um API-Routen zu registrieren oder Setup auszuführen, das stattfinden muss, bevor die wichtigsten API-Routendefinitionen geladen werden.

Wo es läuft

Dieses Ereignis wird in routes/api.php ausgelöst, bevor NexoPOS die Haupt-API-Routen definiert.

Verfügbare Objekteigenschaften

• Dieses Ereignis macht keine Konstruktor-Eigenschaften verfügbar. Es wird als Lebenszyklus-Signal verwendet, während Routendateien geladen werden.

Hörerbeispiel

<?php

use App\Events\BeforeStartApiRouteEvent;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Route;

Event::listen( BeforeStartApiRouteEvent::class, function () {
    Route::prefix( 'my-module-api' )->group( function () {
        Route::get( 'status', fn () => [ 'status' => 'ok' ] );
    } );
} );

Zusammenfassung

• Verwenden Sie dieses Ereignis, wenn ein Modul Routen während der Phase des Bootstrapens der passenden Route registrieren muss.
• Registrieren Sie nur die Routen, die zum aktuellen Routen-Dateikontext gehören.