Início
NexoPOS

Antes de Iniciar Evento de Rota da API

BeforeStartApiRouteEvent é disparado enquanto o NexoPOS está carregando as rotas da API. Os módulos podem usá-lo para registrar rotas da API ou executar uma configuração que precisa acontecer antes de as principais definições das rotas da API serem carregadas.

Onde Funciona

Este evento é disparado em routes/api.php antes do NexoPOS incluir as definições principais das rotas da API.

Propriedades disponíveis

  • Este evento não expõe propriedades do construtor. Ele é usado como um sinal de ciclo de vida enquanto os arquivos de rota estão sendo carregados.

Exemplo de ouvinte

<?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' ] );
    } );
} );

Resumo

  • Use este evento quando um módulo precisar registrar rotas durante a fase de inicialização de bootstrapping da rota correspondente.
  • Registre apenas as rotas que pertencem ao contexto do arquivo de rota atual.