feat(api-docs): API-Exposure-Klassifikation — Intern vs. Oeffentlich
Some checks failed
CI / go-lint (push) Has been skipped
CI / python-lint (push) Has been skipped
CI / nodejs-lint (push) Has been skipped
CI / test-go-ai-compliance (push) Failing after 36s
CI / test-python-backend-compliance (push) Successful in 33s
CI / test-python-document-crawler (push) Successful in 20s
CI / test-python-dsms-gateway (push) Successful in 16s

Alle ~640 Endpoints nach Netzwerk-Exposition klassifiziert: public (5 Module, ~30 EP),
partner/Integration (6 Module, ~25 EP), internal (25+ Module, ~550 EP), admin/Wartung (4 EP).
Badges, Filter und Stats in API-Docs + Developer Portal.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Benjamin Admin
2026-03-08 13:31:16 +01:00
parent 56758e8b55
commit 6ff9f1f2f3
5 changed files with 287 additions and 50 deletions

View File

@@ -1,6 +1,20 @@
import Link from 'next/link'
import { DevPortalLayout, ApiEndpoint, InfoBox } from '@/components/DevPortalLayout'
function ExposureBadge({ type }: { type: 'public' | 'partner' | 'internal' | 'admin' }) {
const config = {
public: { label: 'Oeffentlich', className: 'bg-green-100 text-green-800' },
partner: { label: 'Integration', className: 'bg-blue-100 text-blue-800' },
internal: { label: 'Intern', className: 'bg-gray-100 text-gray-700' },
admin: { label: 'Wartung', className: 'bg-orange-100 text-orange-800' },
}[type]
return (
<span className={`inline-block text-[10px] font-medium px-1.5 py-0.5 rounded ml-2 ${config.className}`}>
{config.label}
</span>
)
}
export default function ApiReferencePage() {
return (
<DevPortalLayout
@@ -18,6 +32,18 @@ export default function ApiReferencePage() {
Für Self-Hosted-Installationen verwenden Sie Ihre eigene Domain.
</p>
<InfoBox type="info" title="API Exposure">
Jeder Endpoint ist mit einer Exposure-Kategorie gekennzeichnet:
<span className="inline-block text-[10px] font-medium px-1.5 py-0.5 rounded bg-green-100 text-green-800 mx-1">Oeffentlich</span>
Internet-exponiert,
<span className="inline-block text-[10px] font-medium px-1.5 py-0.5 rounded bg-blue-100 text-blue-800 mx-1">Integration</span>
API-Key-authentifiziert,
<span className="inline-block text-[10px] font-medium px-1.5 py-0.5 rounded bg-gray-100 text-gray-700 mx-1">Intern</span>
nur Admin-Dashboard,
<span className="inline-block text-[10px] font-medium px-1.5 py-0.5 rounded bg-orange-100 text-orange-800 mx-1">Wartung</span>
nur Setup.
</InfoBox>
<h2>Authentifizierung</h2>
<p>
Alle API-Anfragen erfordern einen gültigen API Key im Header:
@@ -33,7 +59,7 @@ export default function ApiReferencePage() {
<h2>API Endpoints</h2>
<h3>State Management</h3>
<h3>State Management <ExposureBadge type="internal" /></h3>
<p>
Verwalten Sie den SDK-State für Ihren Tenant.
</p>
@@ -60,7 +86,7 @@ export default function ApiReferencePage() {
</Link>
</p>
<h3>RAG Search</h3>
<h3>RAG Search <ExposureBadge type="partner" /></h3>
<p>
Durchsuchen Sie den Compliance-Korpus (DSGVO, AI Act, NIS2).
</p>
@@ -82,7 +108,7 @@ export default function ApiReferencePage() {
</Link>
</p>
<h3>Document Generation</h3>
<h3>Document Generation <ExposureBadge type="internal" /></h3>
<p>
Generieren Sie Compliance-Dokumente automatisch.
</p>
@@ -109,7 +135,7 @@ export default function ApiReferencePage() {
</Link>
</p>
<h3>Export</h3>
<h3>Export <ExposureBadge type="internal" /></h3>
<p>
Exportieren Sie den Compliance-Stand in verschiedenen Formaten.
</p>
@@ -126,7 +152,7 @@ export default function ApiReferencePage() {
</Link>
</p>
<h3>Consent Management</h3>
<h3>Consent Management <ExposureBadge type="public" /></h3>
<p>
Verwalten Sie Einwilligungen, rechtliche Dokumente und Cookie-Banner-Konfigurationen.
</p>
@@ -142,7 +168,7 @@ export default function ApiReferencePage() {
</Link>
</p>
<h3>DSFA Datenschutz-Folgenabschätzung</h3>
<h3>DSFA Datenschutz-Folgenabschätzung <ExposureBadge type="internal" /></h3>
<p>
Verwalten Sie Datenschutz-Folgenabschätzungen gemäß Art. 35 DSGVO mit vollständigem
Audit-Trail, Status-Workflow und Risikobewertung.

View File

@@ -132,6 +132,68 @@ function ComplianceDashboard() {
</ul>
</InfoBox>
{/* API Exposure Classification */}
<h2>API-Exposure-Klassifikation</h2>
<p>
Das SDK klassifiziert alle API-Endpoints nach ihrer Netzwerk-Exposition.
Von den ~640 Endpoints sind nur ~9% oeffentlich exponiert.
</p>
<div className="my-4 overflow-x-auto not-prose">
<table className="min-w-full divide-y divide-gray-200">
<thead className="bg-gray-50">
<tr>
<th className="px-4 py-3 text-left text-xs font-medium text-gray-500 uppercase">Kategorie</th>
<th className="px-4 py-3 text-left text-xs font-medium text-gray-500 uppercase">Badge</th>
<th className="px-4 py-3 text-left text-xs font-medium text-gray-500 uppercase">Bedeutung</th>
<th className="px-4 py-3 text-left text-xs font-medium text-gray-500 uppercase">~Endpoints</th>
</tr>
</thead>
<tbody className="bg-white divide-y divide-gray-200 text-sm">
<tr>
<td className="px-4 py-3 font-medium">public</td>
<td className="px-4 py-3">
<span className="inline-block text-xs font-medium px-2 py-0.5 rounded bg-green-100 text-green-800">Oeffentlich</span>
</td>
<td className="px-4 py-3 text-gray-600">Von Endnutzern/Browsern erreichbar (Internet)</td>
<td className="px-4 py-3">~30</td>
</tr>
<tr>
<td className="px-4 py-3 font-medium">partner</td>
<td className="px-4 py-3">
<span className="inline-block text-xs font-medium px-2 py-0.5 rounded bg-blue-100 text-blue-800">Integration</span>
</td>
<td className="px-4 py-3 text-gray-600">Fuer externe Systeme (CI/CD, LLM-Provider, API-Key/OAuth)</td>
<td className="px-4 py-3">~25</td>
</tr>
<tr>
<td className="px-4 py-3 font-medium">internal</td>
<td className="px-4 py-3">
<span className="inline-block text-xs font-medium px-2 py-0.5 rounded bg-gray-100 text-gray-700">Intern</span>
</td>
<td className="px-4 py-3 text-gray-600">Nur Admin-Dashboard, nicht Internet-exponiert</td>
<td className="px-4 py-3">~550</td>
</tr>
<tr>
<td className="px-4 py-3 font-medium">admin</td>
<td className="px-4 py-3">
<span className="inline-block text-xs font-medium px-2 py-0.5 rounded bg-orange-100 text-orange-800">Wartung</span>
</td>
<td className="px-4 py-3 text-gray-600">Setup/Maintenance nach Deployment deaktivieren</td>
<td className="px-4 py-3">~4</td>
</tr>
</tbody>
</table>
</div>
<InfoBox type="info" title="Sicherheitshinweis">
<p>
Bei Self-Hosted-Deployments stellen Sie sicher, dass nur <strong>public</strong> und
<strong> partner</strong> Endpoints ueber den Reverse Proxy erreichbar sind.
Interne und Wartungs-Endpoints sollten ausschliesslich im Docker-Netzwerk / VPN erreichbar sein.
</p>
</InfoBox>
{/* Features */}
<h2>Hauptfunktionen</h2>
<div className="grid grid-cols-1 md:grid-cols-2 gap-4 not-prose">