Was die Integration umfasst: Apiary

Apiary ist eine Plattform für API-Design und -Dokumentation, die von API- und Produktentwicklungsteams genutzt wird. Die offizielle Entwicklerdokumentation nennt API-Beschreibungen, Dokumentation, Mock-Server und Tests als Teil ihres Arbeitsmodells. Ein praktischer erster Entwurf besteht darin, einen Datensatztyp auszuwählen und den Verantwortlichen sowie die Entscheidung sichtbar zu machen. Sorgen Sie bei Apiary dafür, dass API-Beschreibung, Beispiel-Austausch, Mock-Verhalten und Testergebnis bei Änderungen der Schnittstelle aufeinander abgestimmt bleiben.

Ein praktischer erster Workflow

Verknüpfen Sie das Erstellen, Aktualisieren oder die Freigabe einer API-Beschreibung mit einer dokumentierten Entscheidung zur entsprechenden API-Beschreibung. Stellen Sie sicher, dass der Connector die erforderlichen Felder und Ereignisse bereitstellt, übergeben Sie nur den notwendigen Kontext an Beam und definieren Sie die zulässige nächste Aktion. Beziehen Sie bei Ausnahmen, Berechtigungsfehlern und Entscheidungen, die nicht in der Quelldokumentation abgedeckt sind, eine Person in den Prozess ein.

Zu validierende Workflow-Muster

• Beginnen Sie mit der Erstellung, Aktualisierung oder Freigabebereitschaft eines API-Beschreibung-Datensatzes. Testen Sie, ob der Connector die erforderlichen Felder der API-Beschreibung an Beam übergeben kann; wenden Sie eine genehmigte Regel an und geben Sie den nächsten Schritt an den zuständigen Verantwortlichen zurück.

• Validieren Sie bei einer API-Beschreibung, die überprüft werden muss, das Ereignis und den Rückschreibepfad, bevor Sie Beam verwenden, um eine Benachrichtigung, eine Aufgabe oder eine Überprüfung von Ausnahmen vorzubereiten.

Operativer Nutzen

• Ein klar abgegrenzter erster Workflow mit einem benannten Verantwortlichen und einem eindeutigen Endpunkt.

• Eine nützlichere Protokollierung dessen, was geprüft, entschieden und übergeben wurde.

• Ein sichererer Rollout-Pfad für Ausnahmen, die weiterhin menschliches Urteilsvermögen erfordern.

Bevor Sie starten

Überprüfen Sie die für Ihren Beam Workspace verfügbaren Lese-, Schreib-, Such-, Benachrichtigungs- und Ereignis-Operationen des Connectors. Bestätigen Sie die Authentifizierungsmethode des Anbieters, die erforderlichen Berechtigungen (Scopes), Tarif-Limits und etwaige Genehmigungsanforderungen. Betrachten Sie die beiden oben genannten Workflow-Muster als Entwürfe zur Validierung, nicht als Versprechen einer universellen Abdeckung.