MuleSoft API-Governance, die wirkt: von der Confluence-Richtlinie zur durchgesetzten Policy
Die meisten API-Richtlinien existieren nur in Confluence. So machen Sie aus einer MuleSoft-API-Governance-Richtlinie automatisch geprüfte Regeln, durchgesetzte Policies und einen messbaren Compliance-Score.
Die kurze Antwort
API-Governance sind die Regeln, nach denen APIs entworfen, abgesichert, gebaut, deployt und stillgelegt werden. Dazu gehören die Mechanismen, die prüfen, ob diese Regeln eingehalten werden. Bei MuleSoft funktioniert Governance nur, wenn jede Regel der Richtlinie an einer festen Stelle durchgesetzt wird: mit einem Ruleset beim Design, einer Prüfung in der Pipeline, einer Policy zur Laufzeit oder einer regelmäßigen Compliance-Prüfung. Eine Regel, die nirgends geprüft wird, bleibt ein frommer Wunsch.
Warum die Confluence-Richtlinie nicht reicht
Fast jede Organisation, mit der wir sprechen, hat eine API-Richtlinie. Meist ist sie gut: Namenskonventionen, Versionierung, Fehlerformate, Sicherheitsklassen, Logging-Regeln. Und meist wird sie nicht durchgesetzt. Das Entwicklungsteam liest sie einmal, neue Kolleginnen und Kollegen gar nicht. Externe Dienstleister legen sie auf ihre eigene Art aus.
Ein reales Beispiel: Ein großer deutscher Verband hatte eine sorgfältige API-Security-Richtlinie in Confluence und sogar einen eigenen Linter in der CI-Pipeline mit 31 Regeln für Mule-Code und API-Verträge. Dann haben wir die Richtlinie mit dem verglichen, was in API Manager wirklich aktiv war. Ergebnis: Keine der acht deployten APIs war konform. Die JWT-Validierung fehlte überall. Der Linter prüfte den Code im Repository. Was tatsächlich deployt war, prüfte niemand.
Governance ist nicht das, was man aufschreibt. Governance ist das, was jeden Tag automatisch geprüft wird.
Die vier Durchsetzungspunkte
Wir ordnen jede Regel einer Richtlinie einem von vier Durchsetzungspunkten zu. Jeder Punkt fängt eine andere Art von Fehler ab.
1. Designzeit: die Spezifikation. Regeln zum API-Vertrag gehören in ein Ruleset, das auf jeder Spezifikation in Exchange läuft. Anypoint API Governance kann Rulesets auf RAML- und OAS-Assets anwenden und die Konformität je Asset anzeigen. Typische Regeln: Jede Operation deklariert 400, 401, 403, 429 und 500; jede API hat ein Security Scheme, auch der Health-Endpunkt; Namen folgen der Konvention; für jede Antwort gibt es Beispiele.
2. Buildzeit: die Pipeline. Regeln zum Mule-Code gehören in die CI-Pipeline: ein Linter auf dem Mule-XML, MUnit mit Mindestabdeckung und eine Prüfung, dass keine Secrets oder Keystores im Artefakt landen. Eine verletzte Regel bricht den Build ab. Hier investieren die meisten Organisationen bereits. Das ist gut, aber die Pipeline sieht nur das Repository.
3. Deployzeit: die Verbindung zwischen App und API. Die am meisten unterschätzte Regel: kein Deployment ohne API Autodiscovery. Ist die Anwendung nicht mit ihrer API-Instanz verknüpft, kann API Manager keine Policy anwenden. Die Policies selbst sollte die Deployment-Pipeline automatisch setzen, passend zur Sicherheitsklasse der API und über die Schnittstellen von API Manager. Nicht per Hand in der Oberfläche.
4. Laufzeit: was wirklich live ist. Eine regelmäßige Prüfung vergleicht die deployte Landschaft mit der Richtlinie: welche Policies je API und Umgebung aktiv sind, welche internen APIs öffentliche Endpunkte haben, welche Version gegen welche veröffentlichte Spezifikation läuft. Nur dieser Durchsetzungspunkt erkennt Drift, manuelle Änderungen und vergessene Deployments.
Sicherheitsklassen: das Herzstück einer funktionierenden Richtlinie
Definieren Sie Policies nicht je API. Definieren Sie wenige Sicherheitsklassen und ordnen Sie jede API genau einer Klasse zu. Jede Klasse hat Pflicht- und verbotene Policies. Ein typischer Satz:
- Extern, Maschine zu Maschine (Partner, B2B): Client Credentials oder JWT-Validierung, Client-ID-Enforcement, Rate Limiting oder SLA-Stufen, wo möglich IP-Allowlist.
- Extern, Endnutzer (Apps, Portale): JWT-Validierung gegen Ihren Identity Provider, Rate Limiting, Threat Protection.
- Interne Process-API: JWT-Validierung oder Client-ID-Enforcement, kein Public Endpoint.
- Interne System-API: Client-ID-Enforcement, kein Public Endpoint, nur von Process-APIs aufrufbar.
Mit Klassen wird die Prüfung einfach: Klasse aus den Metadaten der API lesen, aktive Policies aus API Manager lesen, vergleichen. Das Ergebnis ist ein Compliance-Score je API, je Klasse und für die gesamte Landschaft.
Vom Fließtext zu prüfbaren Regeln
An diesem Schritt entscheidet sich, ob ein Governance-Vorhaben gelingt. Wir machen aus jedem Absatz der Richtlinie einen oder mehrere Prüfpunkte mit fünf Feldern:
- ID und Kurztitel, zum Beispiel SEC-004 „Policies entsprechen der Sicherheitsklasse“.
- Quelle: Link auf die Richtlinienseite und deren Version, damit jeder Befund nachvollziehbar bleibt.
- Schweregrad: kritisch, hoch oder niedrig. Kritisch heißt: blockiert den Produktivgang.
- Prüfart: Regel (vollautomatisch), Review (Expertin, Experte oder assistiertes Review) oder manuell.
- Parameter: die konkreten Werte, etwa Pflicht-Policies je Klasse oder das Namensmuster.
Unserer Erfahrung nach lassen sich etwa 75 bis 80 Prozent einer typischen Richtlinie vollautomatisch prüfen. Der Rest braucht ein Review. Das ist in Ordnung, solange sichtbar bleibt, welche Punkte nicht geprüft wurden.
Drei Fallen, die wir immer wieder sehen
Widersprüchliche Seiten. Richtlinien wachsen über Jahre. Eine Seite sagt „im Error Handler nie loggen“, eine andere „einmal loggen, wo der Fehler gemappt wird“. Wenn man die Richtlinie in Regeln übersetzt, werden solche Widersprüche sichtbar. Sammeln Sie sie und lassen Sie das Architekturgremium einmal entscheiden.
Regeln, die niemand prüfen kann. „Code muss lesbar sein“ ist keine Regel. „Inline-DataWeave über eine Zeile ist nicht erlaubt“ ist eine. Formulieren Sie vage Regeln um, bis sie prüfbar sind, oder kennzeichnen Sie sie als Review-Punkt.
Ausnahmen ohne Ablaufdatum. Jede Landschaft braucht Ausnahmen: eine Legacy-API, die noch kein JWT kann, ein Partner, der Basic Authentication benötigt. Erfassen Sie jede Ausnahme mit Verantwortlichem und Ablaufdatum. Eine Ausnahme ohne Ablaufdatum ist ein dauerhaftes Loch.
Checkliste: Governance, die durchgesetzt wird
- Jede Regel der Richtlinie hat ID, Schweregrad, Quellenlink und Durchsetzungspunkt.
- Jede API trägt ihre Sicherheitsklasse in den Metadaten.
- Pflicht- und verbotene Policies sind je Klasse definiert, nicht je API.
- Ein Designzeit-Ruleset läuft auf jeder Spezifikation in Exchange.
- Die Pipeline bricht ab bei Secrets, mitgelieferten Keystores, fehlenden Tests und Lint-Fehlern.
- Kein Deployment ohne API Autodiscovery, in keiner Umgebung.
- Policies setzt die Pipeline aus der Klasse, nicht ein Mensch per Hand.
- Eine regelmäßige Prüfung vergleicht Live-Policies, Endpunkte und Versionen mit der Richtlinie.
- Der Compliance-Score ist für Architektur und fachliche Verantwortliche sichtbar.
- Ausnahmen haben einen Verantwortlichen und ein Ablaufdatum.
- Widersprüche in der Richtlinie werden protokolliert und von einem Gremium entschieden.
Wo Sie anfangen sollten
Nicht mit neuen Werkzeugen. Beginnen Sie mit einer Messung: Wie konform ist die Landschaft heute, gemessen an Ihrer eigenen Richtlinie? Diese Zahl schafft Dringlichkeit und Prioritäten. In unserem MuleSoft Health Check übersetzen wir Ihre Richtlinie in prüfbare Punkte und wenden sie mit unserer Analyseplattform MuleInsights auf alles Deployte an. Welche Befunde dabei typisch sind, lesen Sie in unserem Beitrag zu den häufigsten Health-Check-Befunden. Danach wird Governance zur Daueraufgabe Ihres Center for Enablement – nicht zum einmaligen Projekt.
Häufige Fragen
Was ist API-Governance bei MuleSoft?
Die Regeln für Entwurf, Absicherung, Bau, Deployment und Stilllegung von APIs auf der Anypoint Platform – plus die Prüfungen, die sie durchsetzen: Rulesets auf Spezifikationen, Pipeline-Checks, Policies in API Manager und regelmäßige Compliance-Prüfungen.
Reicht Anypoint API Governance aus?
Nein, nicht allein. Es deckt die Konformität der Spezifikationen beim Design gut ab. Es prüft aber weder Ihren Mule-Code noch Ihre Deployments. Und es prüft nicht, ob die Live-Policies Ihren Sicherheitsklassen entsprechen. Sie brauchen alle vier Durchsetzungspunkte.
Wie viel einer Richtlinie lässt sich automatisch prüfen?
Nach unserer Erfahrung etwa 75 bis 80 Prozent. Der Rest sind Review-Punkte, die als „nicht geprüft“ sichtbar sein sollten, statt stillschweigend zu entfallen.
Wem gehört die API-Governance?
Meist dem Center for Enablement oder dem Integrationsarchitektur-Team. Die fachlich Verantwortlichen jeder API verantworten deren Ausnahmen.
Von Bassem Fawaz · #mulesoft #api-governance #api-security #anypoint #c4e