mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-09-19 19:18:16 +00:00
38883e8d46
Added support for mulit-line endpoint descriptions via blank intermediate lines in php controller method docblocks. Also tweaks endpoint header design for better flexing and alignment.
57 lines
2.1 KiB
PHP
57 lines
2.1 KiB
PHP
<div class="flex-container-row items-center gap-m">
|
|
<span class="api-method text-mono" data-method="{{ $endpoint['method'] }}">{{ $endpoint['method'] }}</span>
|
|
<h5 id="{{ $endpoint['name'] }}" class="text-mono pb-xs">
|
|
@if($endpoint['controller_method_kebab'] === 'list')
|
|
<a style="color: inherit;" target="_blank" rel="noopener" href="{{ url($endpoint['uri']) }}">{{ url($endpoint['uri']) }}</a>
|
|
@else
|
|
<span>{{ url($endpoint['uri']) }}</span>
|
|
@endif
|
|
</h5>
|
|
<h6 class="text-uppercase text-muted text-mono ml-auto">{{ $endpoint['controller_method_kebab'] }}</h6>
|
|
</div>
|
|
|
|
<div class="mb-m">
|
|
@foreach(explode("\n", $endpoint['description'] ?? '') as $descriptionBlock)
|
|
<p class="mb-xxs">{{ $descriptionBlock }}</p>
|
|
@endforeach
|
|
</div>
|
|
|
|
@if($endpoint['body_params'] ?? false)
|
|
<details class="mb-m">
|
|
<summary class="text-muted">{{ $endpoint['method'] === 'GET' ? 'Query' : 'Body' }} Parameters</summary>
|
|
<table class="table">
|
|
<tr>
|
|
<th>Param Name</th>
|
|
<th>Value Rules</th>
|
|
</tr>
|
|
@foreach($endpoint['body_params'] as $paramName => $rules)
|
|
<tr>
|
|
<td>{{ $paramName }}</td>
|
|
<td>
|
|
@foreach($rules as $rule)
|
|
<code class="mr-xs">{{ $rule }}</code>
|
|
@endforeach
|
|
</td>
|
|
</tr>
|
|
@endforeach
|
|
</table>
|
|
</details>
|
|
@endif
|
|
|
|
@if($endpoint['example_request'] ?? false)
|
|
<details component="details-highlighter" class="mb-m">
|
|
<summary class="text-muted">Example Request</summary>
|
|
<pre><code class="language-json">{{ $endpoint['example_request'] }}</code></pre>
|
|
</details>
|
|
@endif
|
|
|
|
@if($endpoint['example_response'] ?? false)
|
|
<details component="details-highlighter" class="mb-m">
|
|
<summary class="text-muted">Example Response</summary>
|
|
<pre><code class="language-json">{{ $endpoint['example_response'] }}</code></pre>
|
|
</details>
|
|
@endif
|
|
|
|
@if(!$loop->last)
|
|
<hr>
|
|
@endif |