webapp/bookstack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-07-28 17:02:04 +03:00
Code Activity

Added a view for the API docs

Browse Source
This commit is contained in:
Dan Brown
2020-01-15 20:18:02 +00:00
parent bed2498667
commit 45b5e631e2
9 changed files with 133 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
resources/views/api-docs/index.blade.php Normal file
View File

@ -0,0 +1,51 @@
@extends('simple-layout')
@section('body')
<div class="container pt-xl">
<div class="grid right-focus reverse-collapse">
<div>
@foreach($docs as $model => $endpoints)
<p class="text-uppercase text-muted mb-xm mt-l"><strong>{{ $model }}</strong></p>
@foreach($endpoints as $endpoint)
<div class="mb-xs">
<a href="#{{ $endpoint['name'] }}" class="text-mono">
<span class="api-method" data-method="{{ $endpoint['method'] }}">{{ $endpoint['method'] }}</span>
/{{ $endpoint['uri'] }}
</a>
</div>
@endforeach
@endforeach
</div>
<div>
@foreach($docs as $model => $endpoints)
<section class="card content-wrap auto-height">
<h1 class="list-heading text-capitals">{{ $model }}</h1>
@foreach($endpoints as $endpoint)
<h5 id="{{ $endpoint['name'] }}" class="text-mono mb-m">
<span class="api-method" data-method="{{ $endpoint['method'] }}">{{ $endpoint['method'] }}</span>
{{ url($endpoint['uri']) }}
</h5>
<p class="mb-m">{{ $endpoint['description'] ?? '' }}</p>
@if($endpoint['example_response'] ?? false)
<details details-highlighter>
<summary class="text-muted">Example Response</summary>
<pre><code class="language-json">{{ $endpoint['example_response'] }}</code></pre>
</details>
<hr class="mt-m">
@endif
@endforeach
</section>
@endforeach
</div>
</div>
</div>
@stop