Wie finde ich API-Governance?

Wenn Sie Ihre Spezifikationsdatei bearbeiten möchten, stehen Ihnen mehrere verschiedene Ansichten zur Verfügung. Eine davon heißt Governance. In dieser Ansicht sehen Sie die Ergebnisse eines Audits und können zu jeder Warnung oder jedem Fehler basierend auf den von Ihnen festgelegten Regeln Kommentare abgeben.

Wozu wird die API-Governance beitragen?

Hier sind die wichtigsten Punkte für API-Best Practices:

• Die Info: Stellen Sie sicher, dass jede API über wesentliche Eigenschaften wie Titel, Beschreibung und andere notwendige Informationen verfügt.

• Versionierung: Erzwingen Sie die Verwendung standardmäßiger semantischer oder datumsbasierter Versionierung für jede API.

• Operationen: Stellen Sie sicher, dass jeder einzelne Vorgang eine Zusammenfassung, Beschreibung und ID enthält.

• Parameter: Standardisieren Sie das Format der Parameternamen und stellen Sie sicher, dass alle Parameter über entsprechende Beschreibungen verfügen.

• Antworten: Befürworten Sie einen gemeinsamen Satz von Statuscodes, Medientypen und Schemaantworten für alle APIs.

• Schema: Standardisieren Sie alle Anforderungs- und Antwortschemata mithilfe von JSON-Schemakomponenten.

Was kommt als nächstes?

Derzeit haben wir eine Grundregel namensOpenAPI Best Practice. Für die Zukunft planen wir die Einführung zusätzlicher Regelsätze, darunter OWASP Top 10 Security und benutzerdefinierte Regelsätze. Seien Sie gespannt auf diese kommenden Ergänzungen.

API-Governance umfasst mehr als nur Design und Standards; Es geht darum, Menschen zu stärken und den Wert von APIs zu maximieren. Durch den Einsatz von Automatisierung, Workshops und Schulungen unterstützt die API-Governance Benutzer bei der Entwicklung von Sicherheitsmaßnahmen, Produktdefinitionen und Implementierungsstrategien. Um ihre Wirksamkeit sicherzustellen, ist es wichtig, alle Komponenten und Auswirkungen der API-Governance anzuerkennen. Weitere Hinweise finden Sie im Apigit-Blog. Hier finden Sie kommende Beiträge zu wichtigen API-Governance-Themen.