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

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: Lösungs- & Schnittstellendesign

Einzubeziehende Personen

Zugehörige Ressourcen

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.

So sieht Erfolg aus

Bereitstellung von wiederverwendbaren Designmustern, gemeinsamen Standards und Validierungstools für API-Spezifikationen. Sicherstellen, dass Designentscheidungen konsistent, frühzeitig überprüft und auf die Geschäftsabsicht ausgerichtet sind.

  1. Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen. — Domain Canvas
  2. 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
  3. Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden. — REST Canvas
  4. Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden. — Event Canvas
  5. Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.
  6. 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
  7. Wenden Sie Contract-First- oder Design-First-Ansätze an, um den API-Schnittstellenvertrag vor der Implementierung zu erfassen und zu validieren.
  8. 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

API-Entwurfslinie

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

Zugehörige Ressourcen

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

Ressourcen

Resources for API-Design

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

  1. Zuordnung von API-Interaktionen zu Benutzeraufgaben
  2. Definieren Sie Endpunkte für jede Interaktion
  3. Inputs und Outputs für jede Interaktion zu dokumentieren
  4. Angabe von Validierungsregeln und -beschränkungen
  5. 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.