Konzentriert sich auf Entwurfsprinzipien und Best Practices für Schnittstellen und Integrationslösungen.
WerNicht ausgewähltWarumNicht ausgewähltWoAPI-DesignZyklusAPI-ProduktisierungszyklusAPI-Entwurfslinie
Station
API-Design
Erstellen Sie API-Designs, die konsistent, wiederverwendbar und auf Geschäftszielen und gemeinsamen Standards basieren.
Beim Entwurf von APIs geht es nicht nur um die Benennung von Endpunkten. Gutes Design stellt sicher, dass APIs benutzerfreundlich, konsistent und auf Geschäfts- und technische Ziele ausgerichtet sind. Schlecht gestaltete APIs führen zu enger Kopplung, geringer Wiederverwendung und kostspieligen Nacharbeiten in den Teams.
Ihre Route auf der Karte
Durch die Methode navigieren
Station, Zyklus oder Stakeholder-Perspektive auswählen, um die Methode zu erkunden.
Ergebnisse
- Gut dokumentierte und konsistente API-Designs
- Wiederverwendbare und validierte API-Schnittstellenverträge
- Entwürfe, die auf Domänenmodelle und Interaktionsmuster abgestimmt sind
- Rückverfolgbarkeit des Designs zum Geschäftswert
Ablaufkriterien
Einstiegskriterien
- Die Capability erfüllt einen klaren Geschäftsbedarf und kann von den vorgesehenen Nutzern wiederverwendet werden.
- Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.
- Das Wertversprechen der Capability wurde mit Geschäfts- und Nutzer-Stakeholdern validiert.
- Die Nutzersegmente sind identifiziert.
- Eine übergeordnete Roadmap für die Umsetzung ist definiert.
Austrittskriterien
- 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.
Einzubeziehende Personen
Zugehörige Ressourcen
Interaction CanvasDefinieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.REST CanvasEntwurf von APIs unter Verwendung von RESTful-Prinzipien, Definition von Ressourcen, Verben und Beispielanforderungen und -antworten.Event CanvasEntwerfen Sie ereignisgesteuerte APIs, indem Sie Ereignisse, Auslöser und Verarbeitungslogik definieren.API Audit ChecklisteEine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.API Design PrinzipienEin prägnanter Leitfaden zu API-Benutzerfreundlichkeit, Auffindbarkeit und Konsistenz, der auf gemeinsamen Designregeln und echten Kundenbedürfnissen basiert.Domain CanvasEin Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.