@push('scripts') @vite('resources/js/api-docs.js') @endpush

Documentação da API

Referência completa dos endpoints do aplicativo, com testador interativo para executar cada chamada diretamente daqui.

Base URL: {{ url('/api') }}
{{-- Token de acesso --}}

Necessário para os endpoints marcados com Auth. Execute POST /login abaixo — o token retornado é aplicado automaticamente.

{{-- Índice --}}

Grupos

@foreach ($grupos as $grupo) {{ $grupo['nome'] }} ({{ count($grupo['endpoints']) }}) @endforeach
@foreach ($grupos as $grupo)

{{ $grupo['nome'] }}

{{ $grupo['descricao'] }}

@foreach ($grupo['endpoints'] as $endpoint)
{{ $endpoint['metodo'] }} {{ $endpoint['path'] }} @if ($endpoint['auth']) Auth @else Público @endif {{ $endpoint['titulo'] }}

{{ $endpoint['descricao'] }}

@if (count($endpoint['params']) > 0)
@foreach ($endpoint['params'] as $param) @endforeach
Parâmetro Tipo Obrigatório Descrição
{{ $param['nome'] }} {{ $param['tipo'] }} @if ($param['obrigatorio']) Sim @else Não @endif {{ $param['descricao'] }}
@else

Este endpoint não recebe parâmetros.

@endif {{-- Testador --}}
@if (count($endpoint['params']) > 0)
@foreach ($endpoint['params'] as $param) @php $valor = is_array($endpoint['exemplo']) ? ($endpoint['exemplo'][$param['nome']] ?? null) : null; $inputType = str_contains($param['tipo'], 'integer') || str_contains($param['tipo'], 'decimal') ? 'number' : (str_contains($param['tipo'], 'date') ? 'date' : 'text'); $placeholder = $param['descricao'] . ($valor !== null ? ' (ex.: ' . $valor . ')' : ''); @endphp @endforeach
@endif
@endforeach
@endforeach