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
Lokaler Canvas-Arbeitsbereich
Use the purpose, outcomes, and instructions above as your static reference while capturing evidence in the interactive workspace.
Lokaler Canvas-Arbeitsbereich
Interaction Canvas
Welche Arten von Interaktionen muss diese Capability oder Schnittstelle unterstützen, bevor ein konkretes Protokolldesign gewählt wird? Identifizieren Sie, welche Interaktionsstile wirklich benötigt werden und welche außerhalb des Umfangs liegen. Nutzen Sie dieses Canvas, um die Absicht zu klären, bevor das Ergebnis auf REST, Events oder GraphQL abgebildet wird.
Aktiver Abschnitt: CRUD Interaktionen. Wählen Sie einen Abschnitt mit dem Zeiger aus oder fokussieren Sie ihn und drücken Sie die Eingabe- oder Leertaste.
CRUD Interaktionen
Sind hier Interaktionen im CRUD-Stil erforderlich?
CRUD Input- & Output-Modelle
Was sind die Eingabe- und Ausgabemodelle für die CRUD-Interaktionen, falls dieser Stil benötigt wird?
CRUD Verarbeitung & Validierung
Was sind die Verarbeitungs- und Validierungsregeln für die CRUD-Interaktionen, falls dieser Stil benötigt wird?
Abfragegesteuerte Interaktionen
Welche Lese- oder Abfrageinteraktionen sind erforderlich, um Nutzerfragen zu beantworten?
Abfragegesteuerte Input- & Output-Modelle
Was sind die Eingabe- und Ausgabemodelle für die abfragegesteuerten Interaktionen?
Abfragegesteuerte Verarbeitung & Validierung
Was sind die Verarbeitungs- und Validierungsregeln für die abfragegesteuerten Interaktionen?
Befehlsgesteuerte Interaktionen
Welche Befehle zur Zustandsänderung sind gegebenenfalls erforderlich?
Befehlsgesteuerte Input- & Output-Modelle
Was sind die Eingabe- und Ausgabemodelle für die befehlsgesteuerten Interaktionen, falls dieser Stil benötigt wird?
Befehlsgesteuerte Verarbeitung & Validierung
Was sind die Verarbeitungs- und Validierungsregeln für die befehlsgesteuerten Interaktionen, falls dieser Stil benötigt wird?
Eventgesteuerte Interaktionen
Welche Ereignisse müssen gegebenenfalls veröffentlicht oder verarbeitet werden?
Eventgesteuerte Input- & Output-Modelle
Was sind die Eingabe- und Ausgabemodelle für die ereignisgesteuerten Interaktionen, falls dieser Stil erforderlich ist?
Eventgesteuerte Verarbeitung & Validierung
Was sind die Verarbeitungs- und Validierungsregeln für die ereignisgesteuerten Interaktionen, falls dieser Stil benötigt wird?
APIOps Cycles · CC-BY-SA 4.0 · Osaango Ltd
Related stations
Lösungs- & Schnittstellendesign
Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung.