Anhang A. Arbeitsblätter für den API-Entwurf
Wir haben diese Arbeitsblätter als Ergänzung zu unseren praktischen Design-Tipps hinzugefügt. Die Arbeitsblätter können als Ergänzung zu dem fiktiven Beispiel aus Kapitel 5 verwendet werden oder immer wieder als Vorlagen für deine eigenen API-Designs dienen.
Unternehmensziele definieren
Das Problem
Definiere kurz das Problem und wie es sich auf Kunden und das Unternehmen auswirkt.
Die Auswirkungen
Definiere, wie der Erfolg für deine API aussieht. Wie wird die Welt aussehen, nachdem du deine neue API veröffentlicht hast?
Wichtige User Stories
Liste mehrere wichtige User Stories für deine API mit der folgenden Vorlage auf:
Technologie Architektur
Beschreibe die von dir gewählte Technologiearchitektur und die Gründe für deine Entscheidung. Vielleicht möchtest du auch Diagramme oder Grafiken einfügen, die die Vor- und Nachteile der von dir in Betracht gezogenen Paradigmen zeigen. Hier ist eine optionale Beispieltabelle:
| Muster, Paradigma oder Protokoll berücksichtigt | Profis | Nachteile | Ausgewählt? |
|---|---|---|---|
API-Spezifikationsvorlage
Titel
Autoren
Problem
Lösung
Umsetzung
Beschreibe den Umsetzungsplan in groben Zügen. Du kannst zusätzliche Tabellen oder Diagramme verwenden, um deinen Plan zu beschreiben.
Authentifizierung
Beschreibe, wie Entwickler Zugang zur API erhalten.
Andere ...
Get Entwerfen von Web APIs now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
