Station

API-Audit

Stellen Sie sicher, dass APIs vor der Veröffentlichung und Bereitstellung den geschäftlichen, gestalterischen und betrieblichen Standards entsprechen.

APIs sind langlebige Produkte und müssen den Erwartungen hinsichtlich Qualität, Konsistenz und Compliance entsprechen. Das Audit verbindet Designentscheidungen, Implementierung und Betriebsbereitschaft mit definierten Standards und reduziert so Risiken vor der Bereitstellung.

Ihre Route auf der Karte

Metrokarte

Select a cycle, station, or stakeholder to open its permanent method page.

StrategischGovernanceNutzerTechnischBenutzerfreundlichkeitBenutzerfreundlichkeitMarkteinblickeMarkteinblickeGeschäftszieleGeschäftszieleWettbewerbsanalyseWettbewerbsanalyseÖkosystem-VisionÖkosystem-VisionSkalierbare InfrastrukturSkalierbare InfrastrukturRechtliche Aspekte und Einhaltung von VorschriftenRechtliche Aspekte und Einhaltung von VorschriftenSicherheit und DatenschutzSicherheit und DatenschutzDesignstandardsDesignstandardsVendor ManagementVendor ManagementVertragsgestaltungVertragsgestaltungEntwicklungEntwicklungCI/CDCI/CDTestautomatisierungTestautomatisierungRelease ManagementRelease ManagementServicevereinbarungenServicevereinbarungenNutzerakzeptanzNutzerakzeptanzAPI-PromotionAPI-PromotionPartnerintegrationPartnerintegrationAPI-MentalitätAPI-MentalitätRollen und ZuständigkeitenRollen und ZuständigkeitenUpskillingUpskillingBetriebsleitlinienBetriebsleitlinienPortfoliomanagementPortfoliomanagementBudget- und RessourcenmanagementBudget- und RessourcenmanagementStrategie1API-ProduktstrategieNutzeranforderungen & Onboarding2API Consumer ExperienceArchitektur & Plattformentscheidungen3API-PlattformarchitekturLösungs- & Schnittstellendesign4API-DesignBereitstellung & Betrieb5API-BereitstellungQualitäts- & Bereitschaftssicherung6API-AuditVeröffentlichung & Enablement7API-VeröffentlichungMonitoring & Verbesserung8API-Monitoring &VerbesserungLinie GeschäftsmöglichkeitenLinie PlattformarchitekturAPI-EntwurfslinieBereitstellungslinieLinie Veröffentlichung & EnablementLinie Betriebsmodell

Selected station: Qualitäts- & Bereitschaftssicherung

Einzubeziehende Personen

Zugehörige Ressourcen

Ergebnisse

  • APIs erfüllen interne und externe Standards
  • Klare Dokumentation des API-Designs und der Implementierungsentscheidungen
  • Sicherheit, Leistung und Compliance validiert
  • Geringeres Risiko von Problemen in der Produktion

Ablaufkriterien

Einstiegskriterien

  • Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.
  • Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.
  • Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.
  • Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.

Austrittskriterien

  • Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.
  • Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.
  • Die Schnittstelle und ihre Capabilities sind ausreichend klar für Review, Auditierung und Onboarding dokumentiert.
  • Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.
  • Der Schnittstellenvertrag wurde validiert und gegen funktionale und nicht-funktionale Anforderungen getestet.

So sieht Erfolg aus

Richten Sie einen konsistenten Audit-Prozess ein, der die API-Bereitschaft über alle Lebenszyklusphasen hinweg anhand definierter Kriterien, Nachweise und Standards bewertet. Stellen Sie sicher, dass Lücken frühzeitig erkannt und vor der Veröffentlichung behoben werden.

  1. Führen Sie Audits durch, um sicherzustellen, dass APIs vor der Veröffentlichung organisatorische, technische und rechtliche Standards erfüllen. — API Audit Checkliste
  2. Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Compliance mit den Standards zu überprüfen.
  3. Zusammenarbeit mit Governance-Teams und Domänenexperten, um sicherzustellen, dass APIs für die Produktion bereit sind.

Metro lines

API-Entwurfslinie

Konzentriert sich auf Entwurfsprinzipien und Best Practices für Schnittstellen und Integrationslösungen.

Zugehörige Ressourcen

Browse the resources selected for API-Audit; the summary above explains how they support this station’s work.

Ressourcen

Resources for API-Audit

checklist

API Audit Checkliste

Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.

Ergebnisse

  • Besseres Verständnis der Grundsätze der API Audit Checkliste
  • Standardisierter Ansatz mit API Audit Checkliste
  • Verbesserte Umsetzung der entsprechenden API-Praktiken

So funktioniert es

  1. Verwenden Sie die API Audit Checkliste, um sicherzustellen, dass der API-Entwurf die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.
  2. Führen Sie Audits durch, um die Abdeckung des Lebenszyklus zu bewerten und sicherzustellen, dass die API den geschäftlichen, gestalterischen und betrieblichen Standards entspricht.
  3. Stellen Sie sicher, dass Dokumentation, Sicherheitsmodelle, Gateway-Konfiguration und gesetzliche Anforderungen klar definiert, validiert und durch Nachweise belegt sind.

Relevant cycles

Capability-Produktisierungszyklus

Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird.

API-Produktisierungszyklus

Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs.

Integrationszyklus

Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird.

Automatisierungszyklus

Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten.