Add embedded Swagger UI page with auto-injected JWT auth
All checks were successful
CI / build (push) Successful in 1m16s
CI / docker (push) Successful in 1m9s
CI / deploy (push) Successful in 31s

- New /swagger route with lazy-loaded SwaggerPage that initializes
  swagger-ui-dist and injects the session JWT via requestInterceptor
- Move API link from primary nav to navRight utility area (pill style)
- Code-split swagger chunk (~1.4 MB) so main bundle stays lean

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
hsiegeln
2026-03-15 14:51:15 +01:00
parent e466dc5861
commit 7dec8fbaff
8 changed files with 93 additions and 5 deletions

17
ui/package-lock.json generated
View File

@@ -14,6 +14,7 @@
"react": "^19.2.4",
"react-dom": "^19.2.4",
"react-router": "^7.13.1",
"swagger-ui-dist": "^5.32.0",
"uplot": "^1.6.32",
"zustand": "^5.0.11"
},
@@ -941,6 +942,13 @@
"dev": true,
"license": "MIT"
},
"node_modules/@scarf/scarf": {
"version": "1.4.0",
"resolved": "https://registry.npmjs.org/@scarf/scarf/-/scarf-1.4.0.tgz",
"integrity": "sha512-xxeapPiUXdZAE3che6f3xogoJPeZgig6omHEy1rIY5WVsB3H2BHNnZH+gHG6x91SCWyQCzWGsuL2Hh3ClO5/qQ==",
"hasInstallScript": true,
"license": "Apache-2.0"
},
"node_modules/@tanstack/query-core": {
"version": "5.90.20",
"resolved": "https://registry.npmjs.org/@tanstack/query-core/-/query-core-5.90.20.tgz",
@@ -3027,6 +3035,15 @@
"node": ">=8"
}
},
"node_modules/swagger-ui-dist": {
"version": "5.32.0",
"resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-5.32.0.tgz",
"integrity": "sha512-nKZB0OuDvacB0s/lC2gbge+RigYvGRGpLLMWMFxaTUwfM+CfndVk9Th2IaTinqXiz6Mn26GK2zriCpv6/+5m3Q==",
"license": "Apache-2.0",
"dependencies": {
"@scarf/scarf": "=1.4.0"
}
},
"node_modules/tinyglobby": {
"version": "0.2.15",
"resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz",

View File

@@ -18,6 +18,7 @@
"react": "^19.2.4",
"react-dom": "^19.2.4",
"react-router": "^7.13.1",
"swagger-ui-dist": "^5.32.0",
"uplot": "^1.6.32",
"zustand": "^5.0.11"
},

View File

@@ -61,6 +61,30 @@
gap: 16px;
}
.utilLink {
font-family: var(--font-mono);
font-size: 11px;
font-weight: 500;
color: var(--text-muted);
text-decoration: none;
padding: 4px 10px;
border-radius: 99px;
border: 1px solid var(--border);
transition: all 0.15s;
}
.utilLink:hover {
color: var(--text-primary);
border-color: var(--text-muted);
}
.utilLinkActive {
composes: utilLink;
color: var(--amber);
border-color: rgba(245, 158, 11, 0.3);
background: var(--amber-glow);
}
.envBadge {
font-family: var(--font-mono);
font-size: 11px;

View File

@@ -28,11 +28,6 @@ export function TopNav() {
Applications
</NavLink>
</li>
<li>
<a href="/api/v1/swagger-ui/index.html" target="_blank" rel="noopener noreferrer" className={styles.navLink}>
API
</a>
</li>
{roles.includes('ADMIN') && (
<li>
<NavLink to="/admin/oidc" className={({ isActive }) => isActive ? styles.navLinkActive : styles.navLink}>
@@ -43,6 +38,9 @@ export function TopNav() {
</ul>
<div className={styles.navRight}>
<NavLink to="/swagger" className={({ isActive }) => isActive ? styles.utilLinkActive : styles.utilLink} title="API Documentation">
API
</NavLink>
<span className={styles.envBadge}>{import.meta.env.VITE_ENV_NAME || 'DEV'}</span>
<button className={styles.themeToggle} onClick={toggle} title="Toggle theme">
{theme === 'dark' ? '\u2600\uFE0F' : '\uD83C\uDF19'}

View File

@@ -0,0 +1,5 @@
.container {
max-width: 1440px;
margin: 0 auto;
padding: 24px;
}

View File

@@ -0,0 +1,29 @@
import { useEffect, useRef } from 'react';
import { useAuthStore } from '../../auth/auth-store';
import SwaggerUI from 'swagger-ui-dist/swagger-ui-es-bundle.js';
import 'swagger-ui-dist/swagger-ui.css';
import styles from './SwaggerPage.module.css';
export function SwaggerPage() {
const containerRef = useRef<HTMLDivElement>(null);
const token = useAuthStore((s) => s.accessToken);
useEffect(() => {
if (!containerRef.current) return;
containerRef.current.innerHTML = '';
SwaggerUI({
url: '/api/v1/api-docs',
domNode: containerRef.current,
deepLinking: true,
requestInterceptor: (req: Record<string, unknown>) => {
if (token) {
(req.headers as Record<string, string>)['Authorization'] = `Bearer ${token}`;
}
return req;
},
});
}, [token]);
return <div ref={containerRef} className={styles.container} />;
}

View File

@@ -1,4 +1,5 @@
import { createBrowserRouter, Navigate } from 'react-router';
import { lazy, Suspense } from 'react';
import { AppShell } from './components/layout/AppShell';
import { ProtectedRoute } from './auth/ProtectedRoute';
import { LoginPage } from './auth/LoginPage';
@@ -8,6 +9,8 @@ import { OidcAdminPage } from './pages/admin/OidcAdminPage';
import { RoutePage } from './pages/routes/RoutePage';
import { ApplicationsPage } from './pages/apps/ApplicationsPage';
const SwaggerPage = lazy(() => import('./pages/swagger/SwaggerPage').then(m => ({ default: m.SwaggerPage })));
export const router = createBrowserRouter([
{
path: '/login',
@@ -28,6 +31,7 @@ export const router = createBrowserRouter([
{ path: 'apps', element: <ApplicationsPage /> },
{ path: 'apps/:group/routes/:routeId', element: <RoutePage /> },
{ path: 'admin/oidc', element: <OidcAdminPage /> },
{ path: 'swagger', element: <Suspense fallback={null}><SwaggerPage /></Suspense> },
],
},
],

10
ui/src/swagger-ui-dist.d.ts vendored Normal file
View File

@@ -0,0 +1,10 @@
declare module 'swagger-ui-dist/swagger-ui-es-bundle.js' {
interface SwaggerUIOptions {
url?: string;
domNode?: HTMLElement;
deepLinking?: boolean;
requestInterceptor?: (req: Record<string, unknown>) => Record<string, unknown>;
[key: string]: unknown;
}
export default function SwaggerUI(options: SwaggerUIOptions): void;
}