webapp/bookstack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-11-04 13:31:45 +03:00
Code Activity

API: Re-ordered routes, Improved navigation

Browse Source 
Updated route order to follow some kind of logic.
Updated scrolling sidebar to not be so cut-off in various scenarios.
Added new nav helper to quick jump to specific API models.

Closes #5865
This commit is contained in:
Dan Brown
2025-11-02 14:29:00 +00:00
parent 4a57933cd1
commit d40a68b411
5 changed files with 148 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
resources/views/api-docs/index.blade.php
View File

@@ -2,48 +2,65 @@
@section('body')
<div class="container pt-xl">
<div component="api-nav" class="container">
<div class="grid right-focus reverse-collapse">
<div>
<div class="sticky-sidebar">
<p class="text-uppercase text-muted mb-xm mt-l"><strong>Getting Started</strong></p>
<div refs="api-nav@sidebar" class="sticky-sidebar">
<div class="text-mono">
<div class="mb-xs"><a href="#authentication">Authentication</a></div>
<div class="mb-xs"><a href="#request-format">Request Format</a></div>
<div class="mb-xs"><a href="#listing-endpoints">Listing Endpoints</a></div>
<div class="mb-xs"><a href="#error-handling">Error Handling</a></div>
<div class="mb-xs"><a href="#rate-limits">Rate Limits</a></div>
<div class="mb-xs"><a href="#content-security">Content Security</a></div>
<div class="sticky-sidebar-header py-xl">
<select refs="api-nav@select" name="navigation" id="navigation">
<option value="getting-started" selected>Jump To Section</option>
<option value="getting-started">Getting Started</option>
@foreach($docs as $model => $endpoints)
<option value="{{ str_replace(' ', '-', $model) }}">{{ ucfirst($model) }}</option>
@if($model === 'docs' || $model === 'shelves')
<hr>
@endif
@endforeach
</select>
</div>
<div class="mb-xl">
<p id="sidebar-header-getting-started" class="text-uppercase text-muted mb-xm"><strong>Getting Started</strong></p>
<div class="text-mono">
<div class="mb-xs"><a href="#authentication">Authentication</a></div>
<div class="mb-xs"><a href="#request-format">Request Format</a></div>
<div class="mb-xs"><a href="#listing-endpoints">Listing Endpoints</a></div>
<div class="mb-xs"><a href="#error-handling">Error Handling</a></div>
<div class="mb-xs"><a href="#rate-limits">Rate Limits</a></div>
<div class="mb-xs"><a href="#content-security">Content Security</a></div>
</div>
</div>
@foreach($docs as $model => $endpoints)
<p class="text-uppercase text-muted mb-xm mt-l"><strong>{{ $model }}</strong></p>
<div class="mb-xl">
<p id="sidebar-header-{{ str_replace(' ', '-', $model) }}" class="text-uppercase text-muted mb-xm"><strong>{{ $model }}</strong></p>
@foreach($endpoints as $endpoint)
<div class="mb-xs">
<a href="#{{ $endpoint['name'] }}" class="text-mono inline block mr-s">
<span class="api-method" data-method="{{ $endpoint['method'] }}">{{ $endpoint['method'] }}</span>
</a>
<a href="#{{ $endpoint['name'] }}" class="text-mono">
{{ $endpoint['controller_method_kebab'] }}
</a>
</div>
@endforeach
@foreach($endpoints as $endpoint)
<div class="mb-xs">
<a href="#{{ $endpoint['name'] }}" class="text-mono inline block mr-s">
<span class="api-method" data-method="{{ $endpoint['method'] }}">{{ $endpoint['method'] }}</span>
</a>
<a href="#{{ $endpoint['name'] }}" class="text-mono">
{{ $endpoint['controller_method_kebab'] }}
</a>
</div>
@endforeach
</div>
@endforeach
</div>
</div>
<div style="overflow: auto;">
<div class="pt-xl" style="overflow: auto;">
<section component="code-highlighter" class="card content-wrap auto-height">
<section id="section-getting-started" component="code-highlighter" class="card content-wrap auto-height">
@include('api-docs.parts.getting-started')
</section>
@foreach($docs as $model => $endpoints)
<section class="card content-wrap auto-height">
<section id="section-{{ str_replace(' ', '-', $model) }}" class="card content-wrap auto-height">
<h1 class="list-heading text-capitals">{{ $model }}</h1>
@if($endpoints[0]['model_description'])
<p>{{ $endpoints[0]['model_description'] }}</p>