Konzentriert sich auf Entwurfsprinzipien und Best Practices für Schnittstellen und Integrationslösungen.
Station
Integrationsdesign
Entwerfen Sie Schnittstellenvertrag, Schemas, Payloads und Interaktionsmuster fuer den gewaehlten Integrationsstil.
Gutes Design geht über die Benennung von Endpunkten hinaus. Es stellt sicher, dass die Schnittstelle nutzbar, konsistent, überprüfbar und auf Geschäfts- und Nutzeranforderungen zurückführbar ist.
Ihre Route auf der Karte
Metrokarte
Select a cycle, station, or stakeholder to open its permanent method page.
Selected station: Lösungs- & Schnittstellendesign
Einzubeziehende Personen
Zugehörige Ressourcen
Ergebnisse
- Ein validierter Schnittstellenvertrag für die gewählte Umsetzungsweise
- Wiederverwendbare und validierte 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.
So sieht Erfolg aus
Nutzen Sie passende Designressourcen für die gewählte Umsetzungsweise, z. B. REST, GraphQL, Events, Dateien, Datenprodukte oder direkte Integration.
- Prüfen Sie Domänenobjekte, Begriffe, Regeln und Ownership, bevor Sie den Schnittstellenvertrag entwerfen. — Domain Canvas
- Verwenden Sie das Interaction Canvas, um zu definieren, wie die Nutzer mit der API interagieren werden, um sicherzustellen, dass sie ihren Bedürfnissen und Erwartungen entspricht. — Interaction Canvas
- Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden. — REST Canvas
- Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden. — Event Canvas
- Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.
- Nutzen Sie die Designprinzipien und den API-Styleguide, um Ihre Designentscheidungen an gemeinsamen Regeln auszurichten und eine konsistente Audit-Validierung zu ermöglichen. — API Design Prinzipien
- Wenden Sie Contract-First- oder Design-First-Ansätze an, um den Schnittstellenvertrag vor der Implementierung zu erfassen und zu validieren.
- Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass das API-Design funktionale und nicht-funktionale Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance. — API Audit Checkliste
Metro lines
Zugehörige Ressourcen
Browse the resources selected for Integrationsdesign; the summary above explains how they support this station’s work.
Ressourcen
Resources for Integrationsdesign
canvas
Interaction Canvas
Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.
Ergebnisse
- Klare API-Interaktionsabläufe
- Definierte Inputs und Outputs für jede Interaktion
- Konsistente Validierungsregeln für alle Interaktionen
So funktioniert es
- Zuordnung von API-Interaktionen zu Benutzeraufgaben
- Definieren Sie Endpunkte für jede Interaktion
- Inputs und Outputs für jede Interaktion zu dokumentieren
- Angabe von Validierungsregeln und -beschränkungen
- Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen
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.