API Reference

{{ $content['document_title'] ?? 'API Reference' }}

{{ $repository->full_name }}

Version{{ $content['version'] ?? 'v1' }}
Base URL{{ $content['base_url'] ?? '/api' }}
Generated{{ $generated }}
Groups{{ count($content['groups'] ?? []) }}
{{ $content['document_title'] ?? 'API Reference' }} {{ $generated }}
@if(!empty($content['authentication']))
Authentication
{{ $content['authentication'] }}
@endif @foreach($content['groups'] ?? [] as $group)
{{ $group['name'] }}
@if(!empty($group['description']))
{{ $group['description'] }}
@endif
@foreach($group['endpoints'] ?? [] as $ep)
{{ $ep['method'] ?? 'GET' }} {{ $content['base_url'] ?? '' }}{{ $ep['path'] }} @if(!($ep['auth_required'] ?? true)) PUBLIC @else 🔒 Auth required @endif
@if(!empty($ep['description']))
{{ $ep['description'] }}
@endif @if(!empty($ep['request_body']))
Request Body
@foreach($ep['request_body'] as $param) @endforeach
FieldTypeRequiredDescription
{{ $param['field'] }} {{ $param['type'] ?? 'string' }} @if($param['required'] ?? false)required@elseoptional@endif {{ $param['description'] ?? '' }}
@endif @if(!empty($ep['query_params']))
Query Parameters
@foreach($ep['query_params'] as $param) @endforeach
ParamTypeDescription
{{ $param['field'] ?? $param['param'] }} {{ $param['type'] ?? 'string' }} {{ $param['description'] ?? '' }}
@endif @if(!empty($ep['response_200']))
Response (200)
{{ $ep['response_200'] }}
@endif @if(!empty($ep['response_errors']))
Error Responses
@foreach($ep['response_errors'] as $err) {{ $err }} @endforeach
@endif @if(!empty($ep['example']))
{{ $ep['example'] }}
@endif
@endforeach @endforeach @if(!empty($content['error_codes']))
Standard Error Codes
@foreach($content['error_codes'] as $err)
{{ $err['code'] }} {{ $err['meaning'] }}
@endforeach
@endif