mirror of
https://github.com/HolgerHatGarKeineNode/einundzwanzig-app.git
synced 2026-06-11 14:50:30 +00:00
HolgerHatGarKeineNode
351dd87fa9
- 🌐 Added API documentation annotations for multiple controllers (Meetups, Cities, Countries, Courses, Highscores, Venues), improving public and developer-facing endpoint clarity. - ➕ Integrated and configured the `dedoc/scramble` package for automated OpenAPI documentation generation. - 🔒 Excluded internal routes and actions from API documentation using `ExcludeRouteFromDocs` attributes. - 🌍 Added new localization keys for API Token features across multiple languages (`lv`, `es`, etc.). - 🛠️ Introduced `Group`, `Response`, and `QueryParameter` attributes for better request descriptions and structured documentation. - 🚀 Enhanced functionality for listing operations in controllers with filters and query parameters like `search` and `selected`.
113 lines
4.2 KiB
PHP
113 lines
4.2 KiB
PHP
<!doctype html>
|
|
<html lang="en" data-theme="{{ $config->renderer()->get('theme', 'light') }}">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
|
|
<meta name="color-scheme" content="{{ $config->renderer()->get('theme', 'light') }}">
|
|
<title>{{ $config->get('ui.title') ?? config('app.name') . ' - API Docs' }}</title>
|
|
|
|
<script src="https://unpkg.com/@stoplight/elements@8.4.2/web-components.min.js"></script>
|
|
<link rel="stylesheet" href="https://unpkg.com/@stoplight/elements@8.4.2/styles.min.css">
|
|
|
|
<script>
|
|
const originalFetch = window.fetch;
|
|
|
|
// intercept TryIt requests and add the XSRF-TOKEN header,
|
|
// which is necessary for Sanctum cookie-based authentication to work correctly
|
|
window.fetch = (url, options) => {
|
|
const CSRF_TOKEN_COOKIE_KEY = "XSRF-TOKEN";
|
|
const CSRF_TOKEN_HEADER_KEY = "X-XSRF-TOKEN";
|
|
const getCookieValue = (key) => {
|
|
const cookie = document.cookie.split(';').find((cookie) => cookie.trim().startsWith(key));
|
|
return cookie?.split("=")[1];
|
|
};
|
|
|
|
const updateFetchHeaders = (
|
|
headers,
|
|
headerKey,
|
|
headerValue,
|
|
) => {
|
|
if (headers instanceof Headers) {
|
|
headers.set(headerKey, headerValue);
|
|
} else if (Array.isArray(headers)) {
|
|
headers.push([headerKey, headerValue]);
|
|
} else if (headers) {
|
|
headers[headerKey] = headerValue;
|
|
}
|
|
};
|
|
const csrfToken = getCookieValue(CSRF_TOKEN_COOKIE_KEY);
|
|
if (csrfToken) {
|
|
const { headers = new Headers() } = options || {};
|
|
updateFetchHeaders(headers, CSRF_TOKEN_HEADER_KEY, decodeURIComponent(csrfToken));
|
|
return originalFetch(url, {
|
|
...options,
|
|
headers,
|
|
});
|
|
}
|
|
|
|
return originalFetch(url, options);
|
|
};
|
|
</script>
|
|
|
|
<style>
|
|
html, body { margin:0; height:100%; }
|
|
body { background-color: var(--color-canvas); }
|
|
/* issues about the dark theme of stoplight/mosaic-code-viewer using web component:
|
|
* https://github.com/stoplightio/elements/issues/2188#issuecomment-1485461965
|
|
*/
|
|
[data-theme="dark"] .token.property {
|
|
color: rgb(128, 203, 196) !important;
|
|
}
|
|
[data-theme="dark"] .token.operator {
|
|
color: rgb(255, 123, 114) !important;
|
|
}
|
|
[data-theme="dark"] .token.number {
|
|
color: rgb(247, 140, 108) !important;
|
|
}
|
|
[data-theme="dark"] .token.string {
|
|
color: rgb(165, 214, 255) !important;
|
|
}
|
|
[data-theme="dark"] .token.boolean {
|
|
color: rgb(121, 192, 255) !important;
|
|
}
|
|
[data-theme="dark"] .token.punctuation {
|
|
color: #dbdbdb !important;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body style="height: 100vh; overflow-y: hidden">
|
|
<elements-api
|
|
id="docs"
|
|
@foreach($config->renderer()->all(except: ['theme']) as $key => $value)
|
|
@continue(! $value)
|
|
{{ $key }}="{{ $value === true ? 'true' : ($value === false ? 'false' : $value) }}"
|
|
@endforeach
|
|
/>
|
|
<script>
|
|
(async () => {
|
|
const docs = document.getElementById('docs');
|
|
docs.apiDescriptionDocument = @json($spec);
|
|
})();
|
|
</script>
|
|
|
|
@if($config->renderer()->get('theme', 'light') === 'system')
|
|
<script>
|
|
var mediaQuery = window.matchMedia('(prefers-color-scheme: dark)');
|
|
|
|
function updateTheme(e) {
|
|
if (e.matches) {
|
|
window.document.documentElement.setAttribute('data-theme', 'dark');
|
|
window.document.getElementsByName('color-scheme')[0].setAttribute('content', 'dark');
|
|
} else {
|
|
window.document.documentElement.setAttribute('data-theme', 'light');
|
|
window.document.getElementsByName('color-scheme')[0].setAttribute('content', 'light');
|
|
}
|
|
}
|
|
|
|
mediaQuery.addEventListener('change', updateTheme);
|
|
updateTheme(mediaQuery);
|
|
</script>
|
|
@endif
|
|
</body>
|
|
</html>
|