API-Audit

Überprüfen Sie vor der Veröffentlichung, ob APIs den organisatorischen, technischen und rechtlichen Standards entsprechen.

Ergebnisse

• APIs erfüllen interne und externe Standards

Zugehörige Metro-Linien

• API-Entwurfslinie
• Veröffentlichungs- und Adoptionslinie

Warum das wichtig ist

APIs sind langlebige Produkte und müssen die Erwartungen an Qualität, Konsistenz und Compliance erfüllen. Audits verringern Risiken, verhindern, dass Mängel in die Produktion gelangen, und unterstützen externe Zertifizierungen.

Eintrittskriterien

• Die API-Architektur verwendet Muster, die die Wiederverwendbarkeit und Integration fördern, und wird mit den Stakeholdern validiert.
• Das Design und die Endpunkte der API stehen in klarem Zusammenhang mit ihrem geschäftlichen Nutzen und ihren Funktionen.
• Die API und ihre Endpunkte verfügen über Beschreibungen, die ihren geschäftlichen Nutzen und ihre Funktionen erläutern.
• Die API weist ein einheitliches Design mit unseren anderen API-Produkten auf.
• Der API-Vertrag wurde getestet und erfüllt die funktionalen und nicht-funktionalen Anforderungen.

Austrittskriterien

• Die API besteht Compliance-, Sicherheits- und Audit-Prüfungen.
• Auditberichte werden mit den Stakeholdern geteilt.
• Die API kann in den entsprechenden Gateways und Umgebungen veröffentlicht werden, um die Wiederverwendbarkeit für mehrere API-Nutzer zu unterstützen.
• Die API-Dokumentation ist vollständig und bereit zur Veröffentlichung.

Wie es funktioniert

1. Führen Sie Audits durch, um sicherzustellen, dass APIs vor der Veröffentlichung organisatorische, technische und rechtliche Standards erfüllen.
   API Audit Checkliste Eine umfassende Checkliste zur Überprüfung der API-Bereitschaft vor der Veröffentlichung, die Design, Dokumentation, Sicherheit und die Einhaltung von Richtlinien abdeckt.
2. Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Konformität mit den Standards zu überprüfen.
   Bewährte Praktiken zur API-Einhaltung Sicherstellen, dass APIs durch Dokumentation, Kontrollen und automatisierte Validierungen die rechtlichen, regulatorischen und internen Anforderungen erfüllen.
3. Zusammenarbeit mit Governance-Teams und Domänenexperten, um sicherzustellen, dass APIs für die Produktion bereit sind.

Bei Ihrer Arbeit anwenden

Schaffung von Governance-Frameworks und -Tools für die Validierung von API-Konformität, Leistung und Sicherheit. Überwachen Sie, dass APIs die Validierungskriterien erfüllen.