meldestelle/backend/infrastructure/gateway/docs/index.html
StefanMo 95fe3e0573
chore(ci): Align GH Workflows with Docker SSoT, new paths; minimal SSoT guard; staticAnalysis (#23)
* chore(MP-21): snapshot pre-refactor state (Epic 1)

* chore(MP-22): scaffold new repo structure, relocate Docker Compose, move frontend/backend modules, update Makefile; add docs mapping and env template

* MP-22 Epic 2: Erfolgreich umgesetzt und verifiziert

* MP-23 Epic 3: Gradle/Build Governance zentralisieren

* MP-23 Epic 3: Gradle/Build Governance zentralisieren

* chore(devops)!: Docker-SSoT (.env) konsolidiert, Compose-Mounts ergänzt, Makefile entfernt

- ENV Single Source of Truth
  - docker/.env.example neu (inkl. REDIS_PASSWORD, Ports, Build-Overrides)
  - config/.env(.example) als DEPRECATED markiert (Verweis auf docker/.env[.example])

- Docker Compose vereinheitlicht (docker/docker-compose.yaml)
  - Postgres: zentralen postgresql.conf mounten (../config/postgres/postgresql.conf)
    und Start mit -c config_file=/etc/postgresql/postgresql.conf
  - Redis: zentralen redis.conf mounten (../config/redis/redis.conf)
    und Start via "redis-server … ${REDIS_PASSWORD:+--requirepass $REDIS_PASSWORD}"
  - Web-Nginx: ../config/nginx/nginx.prod.conf → /etc/nginx/nginx.conf (ro)
  - Monitoring: Prometheus/Grafana nutzen ../config/monitoring/* als SSoT

- Frontend/DI/Network (MP-23 Grundlage)
  - :frontend:core:network Modul mit Koin `apiClient` (Ktor + JSON/Retry/Timeout/Logging)
  - Plattform-Basis-URL-Auflösung (JVM: ENV API_BASE_URL; JS: globalThis.API_BASE_URL / Same-Origin)
  - Web index.html setzt API_BASE_URL (Query `?apiBaseUrl=…` > Same-Origin > Fallback)

- Build/Gradle & Module-Refs
  - settings.gradle.kts: neue Frontend-/Backend-Pfade bereits inkludiert
  - Features/Shell: Abhängigkeiten auf :frontend:shared / :frontend:core:* angepasst
  - Ping-API-Refs auf :backend:services:ping:ping-api vereinheitlicht

- Dockerfiles angepasst
  - backend/infrastructure/gateway/Dockerfile → Tasks/Pfade auf :backend:gateway
  - backend/services/ping/Dockerfile → Tasks/Pfade auf :backend:services:ping:ping-service

- Static Analysis / Guards
  - config/detekt/detekt.yml hinzugefügt
  - Leichter Arch-Guard (Frontend) gegen manuelle Authorization-Header vorbereitet

- Doku
  - docs/ARCHITECTURE.md (Struktur, Mapping, Next Steps) ergänzt
  - docs/adr/README.md angelegt

BREAKING CHANGES:
- Makefile komplett entfernt (bitte direkt `docker compose` verwenden)
- ENV-Quelle ist jetzt docker/.env (statt config/.env oder Root)
- Compose-Datei unter docker/docker-compose.yaml (nicht mehr compose.yaml im Repo-Root)

Verifikation (lokal):
- ENV anlegen: `cp docker/.env.example docker/.env` (Werte anpassen)
- Compose prüfen: `docker compose --env-file docker/.env -f docker/docker-compose.yaml config`
- Infrastruktur: `docker compose --env-file docker/.env -f docker/docker-compose.yaml -p meldestelle up -d postgres redis keycloak web-app`
- Services bauen: `docker compose --env-file docker/.env -f docker/docker-compose.yaml -p meldestelle build api-gateway ping-service --no-cache --progress=plain`

Refs: MP-22 (Epic 2), MP-23 (Epic 3)

* chore(devops)!: Docker-SSoT (.env) konsolidiert, Compose-Mounts ergänzt, Makefile entfernt

- ENV Single Source of Truth
  - docker/.env.example neu (inkl. REDIS_PASSWORD, Ports, Build-Overrides)
  - config/.env(.example) als DEPRECATED markiert (Verweis auf docker/.env[.example])

- Docker Compose vereinheitlicht (docker/docker-compose.yaml)
  - Postgres: zentralen postgresql.conf mounten (../config/postgres/postgresql.conf)
    und Start mit -c config_file=/etc/postgresql/postgresql.conf
  - Redis: zentralen redis.conf mounten (../config/redis/redis.conf)
    und Start via "redis-server … ${REDIS_PASSWORD:+--requirepass $REDIS_PASSWORD}"
  - Web-Nginx: ../config/nginx/nginx.prod.conf → /etc/nginx/nginx.conf (ro)
  - Monitoring: Prometheus/Grafana nutzen ../config/monitoring/* als SSoT

- Frontend/DI/Network (MP-23 Grundlage)
  - :frontend:core:network Modul mit Koin `apiClient` (Ktor + JSON/Retry/Timeout/Logging)
  - Plattform-Basis-URL-Auflösung (JVM: ENV API_BASE_URL; JS: globalThis.API_BASE_URL / Same-Origin)
  - Web index.html setzt API_BASE_URL (Query `?apiBaseUrl=…` > Same-Origin > Fallback)

- Build/Gradle & Module-Refs
  - settings.gradle.kts: neue Frontend-/Backend-Pfade bereits inkludiert
  - Features/Shell: Abhängigkeiten auf :frontend:shared / :frontend:core:* angepasst
  - Ping-API-Refs auf :backend:services:ping:ping-api vereinheitlicht

- Dockerfiles angepasst
  - backend/infrastructure/gateway/Dockerfile → Tasks/Pfade auf :backend:gateway
  - backend/services/ping/Dockerfile → Tasks/Pfade auf :backend:services:ping:ping-service

- Static Analysis / Guards
  - config/detekt/detekt.yml hinzugefügt
  - Leichter Arch-Guard (Frontend) gegen manuelle Authorization-Header vorbereitet

- Doku
  - docs/ARCHITECTURE.md (Struktur, Mapping, Next Steps) ergänzt
  - docs/adr/README.md angelegt

BREAKING CHANGES:
- Makefile komplett entfernt (bitte direkt `docker compose` verwenden)
- ENV-Quelle ist jetzt docker/.env (statt config/.env oder Root)
- Compose-Datei unter docker/docker-compose.yaml (nicht mehr compose.yaml im Repo-Root)

Verifikation (lokal):
- ENV anlegen: `cp docker/.env.example docker/.env` (Werte anpassen)
- Compose prüfen: `docker compose --env-file docker/.env -f docker/docker-compose.yaml config`
- Infrastruktur: `docker compose --env-file docker/.env -f docker/docker-compose.yaml -p meldestelle up -d postgres redis keycloak web-app`
- Services bauen: `docker compose --env-file docker/.env -f docker/docker-compose.yaml -p meldestelle build api-gateway ping-service --no-cache --progress=plain`

Refs: MP-22 (Epic 2), MP-23 (Epic 3)

* chore(devops)!: Docker-SSoT (.env) konsolidiert, Compose-Mounts ergänzt, Makefile entfernt

- ENV Single Source of Truth
  - docker/.env.example neu (inkl. REDIS_PASSWORD, Ports, Build-Overrides)
  - config/.env(.example) als DEPRECATED markiert (Verweis auf docker/.env[.example])

- Docker Compose vereinheitlicht (docker/docker-compose.yaml)
  - Postgres: zentralen postgresql.conf mounten (../config/postgres/postgresql.conf)
    und Start mit -c config_file=/etc/postgresql/postgresql.conf
  - Redis: zentralen redis.conf mounten (../config/redis/redis.conf)
    und Start via "redis-server … ${REDIS_PASSWORD:+--requirepass $REDIS_PASSWORD}"
  - Web-Nginx: ../config/nginx/nginx.prod.conf → /etc/nginx/nginx.conf (ro)
  - Monitoring: Prometheus/Grafana nutzen ../config/monitoring/* als SSoT

- Frontend/DI/Network (MP-23 Grundlage)
  - :frontend:core:network Modul mit Koin `apiClient` (Ktor + JSON/Retry/Timeout/Logging)
  - Plattform-Basis-URL-Auflösung (JVM: ENV API_BASE_URL; JS: globalThis.API_BASE_URL / Same-Origin)
  - Web index.html setzt API_BASE_URL (Query `?apiBaseUrl=…` > Same-Origin > Fallback)

- Build/Gradle & Module-Refs
  - settings.gradle.kts: neue Frontend-/Backend-Pfade bereits inkludiert
  - Features/Shell: Abhängigkeiten auf :frontend:shared / :frontend:core:* angepasst
  - Ping-API-Refs auf :backend:services:ping:ping-api vereinheitlicht

- Dockerfiles angepasst
  - backend/infrastructure/gateway/Dockerfile → Tasks/Pfade auf :backend:gateway
  - backend/services/ping/Dockerfile → Tasks/Pfade auf :backend:services:ping:ping-service

- Static Analysis / Guards
  - config/detekt/detekt.yml hinzugefügt
  - Leichter Arch-Guard (Frontend) gegen manuelle Authorization-Header vorbereitet

- Doku
  - docs/ARCHITECTURE.md (Struktur, Mapping, Next Steps) ergänzt
  - docs/adr/README.md angelegt

BREAKING CHANGES:
- Makefile komplett entfernt (bitte direkt `docker compose` verwenden)
- ENV-Quelle ist jetzt docker/.env (statt config/.env oder Root)
- Compose-Datei unter docker/docker-compose.yaml (nicht mehr compose.yaml im Repo-Root)

Verifikation (lokal):
- ENV anlegen: `cp docker/.env.example docker/.env` (Werte anpassen)
- Compose prüfen: `docker compose --env-file docker/.env -f docker/docker-compose.yaml config`
- Infrastruktur: `docker compose --env-file docker/.env -f docker/docker-compose.yaml -p meldestelle up -d postgres redis keycloak web-app`
- Services bauen: `docker compose --env-file docker/.env -f docker/docker-compose.yaml -p meldestelle build api-gateway ping-service --no-cache --progress=plain`

Refs: MP-22 (Epic 2), MP-23 (Epic 3)

* chore(ci): Workflows an Docker-SSoT & neue Struktur angepasst, minimaler SSoT-Guard

- ssot-guard.yml: Option B (minimal) → `docker compose -f docker/docker-compose.yaml config` als Lint
- integration-tests.yml: `./gradlew staticAnalysis` vor Integrationstests
- docs-kdoc-sync.yml: Dokka-Task Fallback (dokkaGfmAll || dokkaGfm), YouTrack-Sync nur wenn Script vorhanden
- deploy-proxmox.yml: Compose-Pfade auf docker/docker-compose.yaml + `--env-file docker/.env`; Build/Test Schritte vereinheitlicht
- ci-main.yml: SSoT-Skripte per `if: hashFiles(...)` guarded, Compose-Lint Fallback; OpenAPI‑Pfad → backend/gateway; ADR‑Pfade → docs/adr/**; `staticAnalysis` in Build integriert
- youtrack-sync.yml: unverändert (funktional)

Refs: MP-22, MP-23

* chore(ci): Workflows an Docker-SSoT & neue Struktur angepasst, minimaler SSoT-Guard

- ssot-guard.yml: Option B (minimal) → `docker compose -f docker/docker-compose.yaml config` als Lint
- integration-tests.yml: `./gradlew staticAnalysis` vor Integrationstests
- docs-kdoc-sync.yml: Dokka-Task Fallback (dokkaGfmAll || dokkaGfm), YouTrack-Sync nur wenn Script vorhanden
- deploy-proxmox.yml: Compose-Pfade auf docker/docker-compose.yaml + `--env-file docker/.env`; Build/Test Schritte vereinheitlicht
- ci-main.yml: SSoT-Skripte per `if: hashFiles(...)` guarded, Compose-Lint Fallback; OpenAPI‑Pfad → backend/gateway; ADR‑Pfade → docs/adr/**; `staticAnalysis` in Build integriert
- youtrack-sync.yml: unverändert (funktional)

Refs: MP-22, MP-23

* fix(ci): create .env from example before validating compose config

* fix(ci): update ssot-guard filename (.yaml) and sync workflow state

* fixing

* fix(webpack): correct sql.js fallback configuration for webpack 5
2025-12-03 12:03:40 +01:00

380 lines
15 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Meldestelle API Documentation</title>
<meta name="description" content="Self-Contained Systems API Gateway for Austrian Equestrian Federation - Modern API documentation and interactive tools.">
<!-- Modern CSS Framework -->
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous">
<link href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.css" rel="stylesheet">
<style>
:root {
--primary-color: #0d6efd;
--secondary-color: #6c757d;
--success-color: #198754;
--info-color: #0dcaf0;
--warning-color: #ffc107;
--danger-color: #dc3545;
--dark-color: #212529;
--light-color: #f8f9fa;
}
body {
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
min-height: 100vh;
font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
}
.hero-section {
background: rgba(255, 255, 255, 0.95);
backdrop-filter: blur(10px);
border-radius: 20px;
box-shadow: 0 20px 40px rgba(0, 0, 0, 0.1);
margin: 2rem 0;
padding: 3rem;
}
.feature-card {
background: white;
border-radius: 15px;
box-shadow: 0 10px 30px rgba(0, 0, 0, 0.1);
transition: transform 0.3s ease, box-shadow 0.3s ease;
border: none;
height: 100%;
}
.feature-card:hover {
transform: translateY(-10px);
box-shadow: 0 20px 40px rgba(0, 0, 0, 0.15);
}
.feature-icon {
width: 80px;
height: 80px;
background: linear-gradient(135deg, var(--primary-color), var(--info-color));
border-radius: 50%;
display: flex;
align-items: center;
justify-content: center;
margin: 0 auto 1.5rem;
color: white;
font-size: 2rem;
}
.btn-primary-custom {
background: linear-gradient(135deg, var(--primary-color), var(--info-color));
border: none;
border-radius: 50px;
padding: 12px 30px;
font-weight: 600;
transition: all 0.3s ease;
text-decoration: none;
display: inline-block;
}
.btn-primary-custom:hover {
transform: translateY(-2px);
box-shadow: 0 10px 20px rgba(13, 110, 253, 0.3);
background: linear-gradient(135deg, var(--info-color), var(--primary-color));
}
.stats-section {
background: rgba(255, 255, 255, 0.9);
backdrop-filter: blur(10px);
border-radius: 15px;
padding: 2rem;
margin: 2rem 0;
}
.stat-item {
text-align: center;
padding: 1rem;
}
.stat-number {
font-size: 2.5rem;
font-weight: bold;
color: var(--primary-color);
display: block;
}
.status-badge {
display: inline-flex;
align-items: center;
gap: 0.5rem;
padding: 0.5rem 1rem;
background: rgba(25, 135, 84, 0.1);
color: var(--success-color);
border-radius: 50px;
font-weight: 600;
border: 2px solid rgba(25, 135, 84, 0.2);
}
.status-indicator {
width: 10px;
height: 10px;
background: var(--success-color);
border-radius: 50%;
animation: pulse 2s infinite;
}
@keyframes pulse {
0% { opacity: 1; }
50% { opacity: 0.5; }
100% { opacity: 1; }
}
.footer-section {
background: rgba(33, 37, 41, 0.9);
backdrop-filter: blur(10px);
border-radius: 15px;
margin-top: 3rem;
}
.system-info {
background: rgba(248, 249, 250, 0.9);
border-radius: 10px;
padding: 1rem;
margin: 1rem 0;
font-family: 'Courier New', monospace;
font-size: 0.9rem;
border-left: 4px solid var(--primary-color);
}
</style>
</head>
<body>
<div class="container-fluid px-4">
<!-- Hero Section -->
<div class="hero-section text-center">
<div class="mb-4">
<div class="status-badge mb-3">
<div class="status-indicator"></div>
System Online
</div>
</div>
<h1 class="display-3 fw-bold text-primary mb-4">
<i class="bi bi-diagram-3"></i>
Meldestelle API Gateway
</h1>
<p class="lead mb-4 text-muted">
Self-Contained Systems API Gateway for Austrian Equestrian Federation
</p>
<p class="fs-5 mb-5">
Modern, scalable API architecture providing unified access to all bounded contexts
including member management, horse registry, event management, and master data services.
</p>
<div class="d-flex flex-wrap gap-3 justify-content-center">
<a href="/swagger" class="btn btn-primary-custom btn-lg" target="_blank">
<i class="bi bi-code-square me-2"></i>
Interactive API Docs
</a>
<a href="../static/docs/index.html" class="btn btn-outline-primary btn-lg">
<i class="bi bi-book me-2"></i>
Documentation Hub
</a>
<a href="/actuator/health" class="btn btn-outline-success btn-lg" target="_blank">
<i class="bi bi-heart-pulse me-2"></i>
Health Status
</a>
</div>
</div>
<!-- Statistics Section -->
<div class="stats-section">
<div class="row text-center">
<div class="col-md-3 stat-item">
<span class="stat-number">6+</span>
<small class="text-muted">Microservices</small>
</div>
<div class="col-md-3 stat-item">
<span class="stat-number">50+</span>
<small class="text-muted">API Endpoints</small>
</div>
<div class="col-md-3 stat-item">
<span class="stat-number">99.9%</span>
<small class="text-muted">Uptime</small>
</div>
<div class="col-md-3 stat-item">
<span class="stat-number">OpenAPI 3.0</span>
<small class="text-muted">Specification</small>
</div>
</div>
</div>
<!-- Features Section -->
<div class="row g-4 my-5">
<div class="col-lg-4 col-md-6">
<div class="card feature-card p-4 text-center">
<div class="feature-icon">
<i class="bi bi-lightning-charge"></i>
</div>
<h4 class="h5 fw-bold">Interactive Documentation</h4>
<p class="text-muted mb-4">
Modern Swagger UI with real-time API testing, request/response examples,
and comprehensive endpoint documentation.
</p>
<a href="/swagger" target="_blank" class="btn btn-outline-primary btn-sm">
Explore API <i class="bi bi-arrow-right"></i>
</a>
</div>
</div>
<div class="col-lg-4 col-md-6">
<div class="card feature-card p-4 text-center">
<div class="feature-icon">
<i class="bi bi-shield-check"></i>
</div>
<h4 class="h5 fw-bold">Health Monitoring</h4>
<p class="text-muted mb-4">
Real-time health checks for all downstream services with circuit breaker
patterns and comprehensive monitoring dashboards.
</p>
<a href="/actuator/health" target="_blank" class="btn btn-outline-primary btn-sm">
View Status <i class="bi bi-arrow-right"></i>
</a>
</div>
</div>
<div class="col-lg-4 col-md-6">
<div class="card feature-card p-4 text-center">
<div class="feature-icon">
<i class="bi bi-diagram-3-fill"></i>
</div>
<h4 class="h5 fw-bold">Microservices Architecture</h4>
<p class="text-muted mb-4">
Clean architecture with bounded contexts: Members, Horses, Events,
Master Data, Authentication, and more.
</p>
<a href="../static/docs/index.html" class="btn btn-outline-primary btn-sm">
Learn More <i class="bi bi-arrow-right"></i>
</a>
</div>
</div>
<div class="col-lg-4 col-md-6">
<div class="card feature-card p-4 text-center">
<div class="feature-icon">
<i class="bi bi-file-earmark-code"></i>
</div>
<h4 class="h5 fw-bold">OpenAPI Specification</h4>
<p class="text-muted mb-4">
Complete OpenAPI 3.0.3 specification with detailed schemas,
examples, and code generation support.
</p>
<a href="/openapi" target="_blank" class="btn btn-outline-primary btn-sm">
View Spec <i class="bi bi-arrow-right"></i>
</a>
</div>
</div>
<div class="col-lg-4 col-md-6">
<div class="card feature-card p-4 text-center">
<div class="feature-icon">
<i class="bi bi-graph-up"></i>
</div>
<h4 class="h5 fw-bold">Metrics & Analytics</h4>
<p class="text-muted mb-4">
Prometheus metrics, distributed tracing, and performance monitoring
with detailed request/response analytics.
</p>
<a href="/actuator/metrics" target="_blank" class="btn btn-outline-primary btn-sm">
View Metrics <i class="bi bi-arrow-right"></i>
</a>
</div>
</div>
<div class="col-lg-4 col-md-6">
<div class="card feature-card p-4 text-center">
<div class="feature-icon">
<i class="bi bi-collection"></i>
</div>
<h4 class="h5 fw-bold">Development Tools</h4>
<p class="text-muted mb-4">
Postman collections, code examples in multiple languages,
and comprehensive developer resources.
</p>
<a href="../static/docs/index.html#resources" class="btn btn-outline-primary btn-sm">
Get Tools <i class="bi bi-arrow-right"></i>
</a>
</div>
</div>
</div>
<!-- System Information -->
<div class="system-info">
<h5 class="fw-bold mb-3"><i class="bi bi-info-circle me-2"></i>System Information</h5>
<div class="row">
<div class="col-md-6">
<strong>Gateway Version:</strong> 1.0.0<br>
<strong>Spring Boot:</strong> 3.x<br>
<strong>Spring Cloud Gateway:</strong> Latest
</div>
<div class="col-md-6">
<strong>Documentation:</strong> OpenAPI 3.0.3<br>
<strong>Service Discovery:</strong> Consul<br>
<strong>Circuit Breaker:</strong> Resilience4j
</div>
</div>
</div>
<!-- Footer -->
<footer class="footer-section text-white text-center py-4">
<div class="container">
<p class="mb-2">
<strong>Meldestelle API Gateway</strong> - Austrian Equestrian Federation
</p>
<p class="mb-0 text-muted">
Modern Self-Contained Systems Architecture | Built with Spring Cloud Gateway
</p>
<div class="mt-3">
<a href="/actuator/info" class="text-white-50 text-decoration-none me-3" target="_blank">
<i class="bi bi-info-circle me-1"></i>System Info
</a>
<a href="../static/docs/index.html" class="text-white-50 text-decoration-none me-3">
<i class="bi bi-book me-1"></i>Documentation
</a>
<a href="/swagger" class="text-white-50 text-decoration-none" target="_blank">
<i class="bi bi-code-square me-1"></i>API Explorer
</a>
</div>
</div>
</footer>
</div>
<!-- Modern JavaScript -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js" integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz" crossorigin="anonymous"></script>
<!-- Optional: Health Status Check -->
<script>
// Optional: Real-time health status check
async function checkHealthStatus() {
try {
const response = await fetch('/actuator/health');
const health = await response.json();
const statusBadge = document.querySelector('.status-badge');
const statusIndicator = document.querySelector('.status-indicator');
if (health.status === 'UP') {
statusBadge.innerHTML = '<div class="status-indicator"></div>System Online';
statusBadge.className = 'status-badge';
} else {
statusBadge.innerHTML = '<div class="status-indicator"></div>System Issues Detected';
statusBadge.className = 'status-badge text-warning';
statusIndicator.style.background = '#ffc107';
}
} catch (error) {
console.log('Health check unavailable in current environment');
}
}
// Check health status on load (only if available)
document.addEventListener('DOMContentLoaded', checkHealthStatus);
</script>
</body>
</html>