164 lines
7.3 KiB
PHP
164 lines
7.3 KiB
PHP
@php
|
|
/** @var Knuckles\Camel\Output\OutputEndpointData $endpoint */
|
|
@endphp
|
|
|
|
<h2 id="{!! Str::slug($group['name']) !!}-{!! $endpoint->endpointId() !!}">{{ $endpoint->metadata->title ?: ($endpoint->httpMethods[0]." ".$endpoint->uri)}}</h2>
|
|
|
|
<p>
|
|
@component('scribe::components.badges.auth', ['authenticated' => $endpoint->metadata->authenticated])
|
|
@endcomponent
|
|
</p>
|
|
|
|
{!! Parsedown::instance()->text($endpoint->metadata->description ?: '') !!}
|
|
|
|
<span id="example-requests-{!! $endpoint->endpointId() !!}">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
@foreach($metadata['example_languages'] as $language)
|
|
|
|
<div class="{{ $language }}-example">
|
|
@include("scribe::partials.example-requests.$language")
|
|
</div>
|
|
|
|
@endforeach
|
|
</span>
|
|
|
|
<span id="example-responses-{!! $endpoint->endpointId() !!}">
|
|
@if($endpoint->isGet() || $endpoint->hasResponses())
|
|
@foreach($endpoint->responses as $response)
|
|
<blockquote>
|
|
<p>Example response ({{$response->description ?: $response->status}}):</p>
|
|
</blockquote>
|
|
@if(count($response->headers))
|
|
<details class="annotation">
|
|
<summary>
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">@foreach($response->headers as $header => $value)
|
|
{{ $header }}: {{ is_array($value) ? implode('; ', $value) : $value }}
|
|
@endforeach </code></pre>
|
|
</details> @endif
|
|
<pre>
|
|
@if(is_string($response->content) && Str::startsWith($response->content, "<<binary>>"))
|
|
<code>[Binary data] - {{ htmlentities(str_replace("<<binary>>", "", $response->content)) }}</code>
|
|
@elseif($response->status == 204)
|
|
<code>[Empty response]</code>
|
|
@else
|
|
@php($parsed = json_decode($response->content))
|
|
{{-- If response is a JSON string, prettify it. Otherwise, just print it --}}
|
|
<code class="language-json">{!! htmlentities($parsed != null ? json_encode($parsed, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES) : $response->content) !!}</code>
|
|
@endif </pre>
|
|
@endforeach
|
|
@endif
|
|
</span>
|
|
<span id="execution-results-{{ $endpoint->endpointId() }}" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-{{ $endpoint->endpointId() }}"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-{{ $endpoint->endpointId() }}"></code></pre>
|
|
</span>
|
|
<span id="execution-error-{{ $endpoint->endpointId() }}" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-{{ $endpoint->endpointId() }}"></code></pre>
|
|
</span>
|
|
<form id="form-{{ $endpoint->endpointId() }}" data-method="{{ $endpoint->httpMethods[0] }}"
|
|
data-path="{{ $endpoint->uri }}"
|
|
data-authed="{{ $endpoint->metadata->authenticated ? 1 : 0 }}"
|
|
data-hasfiles="{{ $endpoint->hasFiles() ? 1 : 0 }}"
|
|
data-isarraybody="{{ $endpoint->isArrayBody() ? 1 : 0 }}"
|
|
data-headers='@json($endpoint->headers)'
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('{{ $endpoint->endpointId() }}', this);">
|
|
<h3>
|
|
Request
|
|
@if($metadata['try_it_out']['enabled'] ?? false)
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-{{ $endpoint->endpointId() }}"
|
|
onclick="tryItOut('{{ $endpoint->endpointId() }}');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-{{ $endpoint->endpointId() }}"
|
|
onclick="cancelTryOut('{{ $endpoint->endpointId() }}');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-{{ $endpoint->endpointId() }}" hidden>Send Request 💥
|
|
</button>
|
|
@endif
|
|
</h3>
|
|
@foreach($endpoint->httpMethods as $method)
|
|
<p>
|
|
@component('scribe::components.badges.http-method', ['method' => $method])@endcomponent
|
|
<b><code>{{$endpoint->uri}}</code></b>
|
|
</p>
|
|
@endforeach
|
|
@if($endpoint->metadata->authenticated && $metadata['auth']['location'] === 'header')
|
|
<p>
|
|
<label id="auth-{{ $endpoint->endpointId() }}" hidden>{{ $metadata['auth']['name'] }} header:
|
|
<b><code>{{ $metadata['auth']['prefix'] }}</code></b><input type="text"
|
|
name="{{ $metadata['auth']['name'] }}"
|
|
data-prefix="{{ $metadata['auth']['prefix'] }}"
|
|
data-endpoint="{{ $endpoint->endpointId() }}"
|
|
data-component="header"></label>
|
|
</p>
|
|
@endif
|
|
@if(count($endpoint->urlParameters))
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
@foreach($endpoint->urlParameters as $attribute => $parameter)
|
|
<p>
|
|
@component('scribe::components.field-details', [
|
|
'name' => $parameter->name,
|
|
'type' => $parameter->type ?? 'string',
|
|
'required' => $parameter->required,
|
|
'description' => $parameter->description,
|
|
'example' => $parameter->example ?? '',
|
|
'endpointId' => $endpoint->endpointId(),
|
|
'component' => 'url',
|
|
])
|
|
@endcomponent
|
|
</p>
|
|
@endforeach
|
|
@endif
|
|
@if(count($endpoint->queryParameters))
|
|
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
|
|
@foreach($endpoint->queryParameters as $attribute => $parameter)
|
|
<p>
|
|
@component('scribe::components.field-details', [
|
|
'name' => $parameter->name,
|
|
'type' => $parameter->type,
|
|
'required' => $parameter->required,
|
|
'description' => $parameter->description,
|
|
'example' => $parameter->example ?? '',
|
|
'endpointId' => $endpoint->endpointId(),
|
|
'component' => 'query',
|
|
])
|
|
@endcomponent
|
|
</p>
|
|
@endforeach
|
|
@endif
|
|
@if(count($endpoint->nestedBodyParameters))
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
@component('scribe::components.body-parameters', ['parameters' => $endpoint->nestedBodyParameters, 'endpointId' => $endpoint->endpointId(),])
|
|
@endcomponent
|
|
@endif
|
|
</form>
|
|
|
|
@if(count($endpoint->responseFields))
|
|
<h3>Response</h3>
|
|
<h4 class="fancy-heading-panel"><b>Response Fields</b></h4>
|
|
@foreach($endpoint->responseFields as $name => $field)
|
|
<p>
|
|
@component('scribe::components.field-details', [
|
|
'name' => $field->name,
|
|
'type' => $field->type,
|
|
'required' => true,
|
|
'description' => $field->description,
|
|
'isInput' => false,
|
|
])
|
|
@endcomponent
|
|
</p>
|
|
@endforeach
|
|
@endif
|