API-Design

Erstellen Sie durchdachte API-Entwürfe, die sich an den Bedürfnissen der Benutzer, den Produktzielen und konsistenten Spezifikationen orientieren.

Ergebnisse

• Gut dokumentierte und konsistente API-Designs

Verwandte U-Bahnlinien

• API-Entwurfslinie

Warum das wichtig ist

Beim Entwurf von APIs geht es nicht nur um die Benennung von Endpunkten. Ein gutes Design stellt sicher, dass APIs benutzbar und konsistent sind und mit den geschäftlichen und technischen Zielen übereinstimmen. Schlecht konzipierte APIs führen zu technischen Schulden, schlechter Akzeptanz und Nacharbeit in den Teams.

Eintrittskriterien

• Die API-Architektur verwendet Muster, die die Wiederverwendbarkeit und Integration fördern, und wird mit den Stakeholdern validiert.
• Das Ziel der API ist es, Backend-Datenmodelle und Diskrepanzen zu verbergen.
• Das Design und die Endpunkte der API stehen in klarem Zusammenhang mit ihrem geschäftlichen Nutzen und ihren Funktionen.
• Die API weist ein einheitliches Design mit unseren anderen API-Produkten auf.

Austrittskriterien

• Die API-Architektur verwendet Muster, die die Wiederverwendbarkeit und Integration fördern, und wird mit den Stakeholdern validiert.
• Das Ziel der API ist es, Backend-Datenmodelle und Diskrepanzen zu verbergen.
• Das Design und die Endpunkte der API stehen in klarem Zusammenhang mit ihrem geschäftlichen Nutzen und ihren Funktionen.
• Die API weist ein einheitliches Design mit unseren anderen API-Produkten auf.

Wie es funktioniert

1. Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen.
   Domain Canvas Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.
2. Verwenden Sie das Interaction Canvas, um zu definieren, wie die Verbraucher mit der API interagieren werden, um sicherzustellen, dass sie ihren Bedürfnissen und Erwartungen entspricht.
   Interaction Canvas Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.
3. Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare API-Verträge zu erstellen, die mit den Beteiligten validiert werden.
   REST Canvas Entwurf von APIs unter Verwendung von RESTful-Prinzipien, Definition von Ressourcen, Verben und Beispielanforderungen und -antworten.
4. Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare API-Verträge zu erstellen, die mit den Beteiligten validiert werden.
   Event Canvas Entwerfen Sie ereignisgesteuerte APIs, indem Sie Ereignisse, Auslöser und Verarbeitungslogik definieren.
5. Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare API-Verträge zu erstellen, die mit den Beteiligten validiert werden.
   GraphQL Canvas Entwerfen Sie GraphQL-APIs, indem Sie Typen, Abfragen, Mutationen und Abonnements definieren.
6. Nutzen Sie die Erkenntnisse, um APIs zu entwickeln, die den Bedürfnissen der Verbraucher entsprechen, und stellen Sie sicher, dass sie auffindbar, verständlich und nutzbar sind.
   API Design Prinzipien Ein präziser Leitfaden für die Benutzerfreundlichkeit, Auffindbarkeit und Konsistenz von APIs, der auf bewährten Designphilosophien und den Bedürfnissen der Benutzer basiert.
7. 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.
   API Audit Checkliste Eine umfassende Checkliste zur Überprüfung der API-Bereitschaft vor der Veröffentlichung, die Design, Dokumentation, Sicherheit und die Einhaltung von Richtlinien abdeckt.

Bei Ihrer Arbeit anwenden

Bereitstellung von wiederverwendbaren Vorlagen, Standards und Validierungstools für API-Spezifikationen. Sicherstellen, dass die Teams Design-Reviews befolgen und Feedback frühzeitig einbeziehen.