{{ $endpoint['method'] }} {{ $endpoint['path'] }}
@if ($endpoint['summary'] !== '')
Summary: {{ $endpoint['summary'] }}
@endif @if ($endpoint['description'] !== '')Description: {{ $endpoint['description'] }}
@endif @if ($endpoint['auth'] !== [])Authentication:
-
@foreach ($endpoint['auth'] as $auth)
- {{ $auth }} @endforeach
Parameters
-
@foreach ($endpoint['parameters'] as $parameter)
{{ $parameter['name'] }}({{ $parameter['location'] }}, {{ $parameter['type'] }}, {{ $parameter['required'] ? 'required' : 'optional' }})
@endforeach
Request Body
-
@foreach ($endpoint['request_fields'] as $field)
{{ $field['name'] }}({{ $field['type'] }}, {{ $field['required'] ? 'required' : 'optional' }})@if ($field['example'] !== null) example:{{ $field['example'] }}@endif
@endforeach
Responses:
-
@foreach ($endpoint['responses'] as $response)
{{ $response['status'] }}{{ $response['description'] }}
@endforeach
Sample request
curl -i \
@if ($endpoint['method'] !== 'GET')
-X {{ $endpoint['method'] }} \
@endif
-H 'Accept: application/json' \
-H 'x-api-key: local-bootstrap-key' \
@if ($endpoint['request_fields'] !== [])
-H 'Content-Type: application/json' \
-d '{
@foreach ($endpoint['request_fields'] as $field)
"{{ $field['name'] }}": {{ $field['example'] !== null ? '"'.$field['example'].'"' : 'null' }}{{ $loop->last ? '' : ',' }}
@endforeach
}' \
@endif
{{ url($endpoint['path']) }}
@if ($endpoint['request_example_json'] !== null)
{{ $endpoint['request_example_json'] }}
@endif
Example Replies
@foreach ($endpoint['response_examples_json'] as $responseExample)Status: {{ $responseExample['status'] }}
{{ $responseExample['body'] }}