# Lösungs- & Schnittstellendesign Canonical page: https://apiopscycles.com/de/stations/api-design Language: de Entity ID: api-design ## Description Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung. ## Why it matters 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. ## Apply in work Nutzen Sie passende Designressourcen für die gewählte Umsetzungsweise, z. B. REST, GraphQL, Events, Dateien, Datenprodukte oder direkte Integration. ## Outcomes - 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 ## Steps 1. Prüfen Sie Domänenobjekte, Begriffe, Regeln und Ownership, bevor Sie den Schnittstellenvertrag entwerfen. 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. 3. Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden. 4. Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden. 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. 7. Wenden Sie Contract-First- oder Design-First-Ansätze an, um den 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. ## Questions - Prüfen Sie Domänenobjekte, Begriffe, Regeln und Ownership, bevor Sie den Schnittstellenvertrag entwerfen. - 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. - Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden. - Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden. - 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. - 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. - Nutzen Sie passende Designressourcen für die gewählte Umsetzungsweise, z. B. REST, GraphQL, Events, Dateien, Datenprodukte oder direkte Integration. - 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. ## Evidence - spec - contract - design-artifact - documentation ## Completion criteria - Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert. — The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders. (ID: architecture-patterns-validated) - Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion. — The API is intended to shield consumers from backend complexity and inconsistencies. (ID: hide-backend-discrepancies) - Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen. — The API design and exposed capabilities clearly trace back to business value and user needs. (ID: design-reflects-business-value) - Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen. — The API design follows our shared API product and design conventions. (ID: api-consistency) ## Role participation and responsibilities - [API-Designer](https://apiopscycles.com/de/roles/api-designer.md) (lead): Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.; suggested-answer-owner: [Canvas für Fähigkeitslösungsdesign](https://apiopscycles.com/de/resources/capability-solution-design-canvas.md) - [Automatisierungsingenieur](https://apiopscycles.com/de/roles/automation-engineer.md) (lead): Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.; suggested-answer-owner: [Automatisierungs-Workflow-Canvas](https://apiopscycles.com/de/resources/automation-workflow-canvas.md) - [Integrationsarchitekt](https://apiopscycles.com/de/roles/integration-architect.md) (lead): Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.; suggested-answer-owner: [Canvas für Integrationslösungsdesign](https://apiopscycles.com/de/resources/integration-solution-design-canvas.md) - [API-Produktverantwortlicher](https://apiopscycles.com/de/roles/api-product-owner.md) (core): Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg. - [Automatisierungsverantwortlicher](https://apiopscycles.com/de/roles/automation-owner.md) (core): Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung. - [Compliance- und Rechtsexperte](https://apiopscycles.com/de/roles/compliance-specialist.md) (core): Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen. - [Domain-Experte](https://apiopscycles.com/de/roles/domain-specialist.md) (core): Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss. - [Fähigkeitsverantwortlicher](https://apiopscycles.com/de/roles/capability-owner.md) (core): Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg. - [Plattform-Architekt](https://apiopscycles.com/de/roles/platform-architect.md) (core): Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird. - [Prozessverantwortlicher](https://apiopscycles.com/de/roles/process-owner.md) (core): Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten. - [Sicherheitsspezialist](https://apiopscycles.com/de/roles/security-specialist.md) (core): Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden. - [Vertreter der API-Nutzer](https://apiopscycles.com/de/roles/api-consumer-specialist.md) (core): Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API. - [API-Entwickler](https://apiopscycles.com/de/roles/api-engineer.md) (consulted): Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind. - [Fachlicher Verantwortlicher](https://apiopscycles.com/de/roles/business-owner.md) (consulted): Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative. - [Verantwortlicher für Dokumentation und DevRel](https://apiopscycles.com/de/roles/api-devrel-specialist.md) (consulted): Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer. ## Cycle-specific guidance - [Capability-Produktisierungszyklus](https://apiopscycles.com/de/cycles/capability-productization-cycle/stations/api-design.md) - [API-Produktisierungszyklus](https://apiopscycles.com/de/cycles/api-productization-cycle/stations/api-design.md) - [Integrationszyklus](https://apiopscycles.com/de/cycles/integration-productization-cycle/stations/api-design.md) - [Automatisierungszyklus](https://apiopscycles.com/de/cycles/automation-cycle/stations/api-design.md)