Geschrieben vonOssi Galkin Vor über einer Woche aktualisiertTable of contentsIn diesem Kurs wird tiefer in die Implementierung von Frends API-Endpunkten eingetaucht. Hier erfahren Sie, wie Sie verknüpfte Prozesse erstellen und wie Sie Header sowie Abfrage- und Pfadparameter in Ihren Endpunkten handhaben. Wir stellen das Intermediate Return Element vor und gehen einige Anwendungsfälle dafür durch. Wir werden sehen, wie die verknüpften Prozesse mit einem manuellen Trigger getestet werden und die häufigsten API-Fehlermeldungen durchgehen und wie diese in Frends debuggt werden.
Erste Schritte
Die Frends API-Endpunkte werden gemäß der API-Spezifikation implementiert, die entweder in YAML oder JSON geschrieben ist und auf der OpenAPI-Spezifikation basiert. Sie müssen auch die Entwürfe für die Vorgänge haben und eine Entscheidung darüber treffen, wie die Authentifizierung mit jedem spezifischen Endpunkt gehandhabt werden soll. Informationen darüber, in welcher Agentengruppe die APIs bereitgestellt werden, sind äußerst wichtig.
Die eigentlichen Endpunkte werden als reguläre Prozesse erstellt. Sie haben zwei Möglichkeiten, die Sie nutzen können, um mit der Erstellung verknüpfter Prozesse zu beginnen. Die erste Möglichkeit besteht darin, den Prozess aus der API-Ansicht zu erstellen, indem Sie auf „Neuen Prozess aus einer neuen API-Endpunktspezifikation erstellen“ klicken. Dadurch wird der Prozesseditor mit vorgefertigten API-Triggern, HTTP-Antwort-Return-Elementen und HTTP-Antwort-Throw-Elementen geöffnet, die wie in der API-Spezifikation konfiguriert sind.
Die andere Möglichkeit besteht darin, auf herkömmliche Weise einen neuen Prozess zu erstellen und die Trigger-, Return- und Throw-Elemente manuell hinzuzufügen. Wenn Sie dies auf diese Weise tun, schlägt Ihnen der Prozesseditor vor, welche API-Endpunkte zur Implementierung verfügbar sind. Beachten Sie, dass Sie zuerst den Endpunkt in der API-Spezifikation erstellen müssen, bevor Sie mit der Implementierung im Prozesseditor beginnen können. Mit dieser Methode können Sie bereits erstellte Prozesse in API-verknüpfte Prozesse ändern. Sie können nur einen verknüpften Prozess mit einem bestimmten API-Endpunkt haben, und der Prozesseditor löst eine Ausnahme aus, wenn der Endpunkt bereits erstellt wurde. Außerdem kann einem Prozess nur ein API-Trigger zugeordnet sein. Dies verhindert, dass Sie Prozesse erstellen, die auf verschiedene Endpunkte in der API hören.
Der nächste Artikel istBeispiel zum Erstellen eines verknüpften Prozesses.
Verwandte ArtikelAPI-VerwaltungEinführung in das Frends-Terminologie-GlossarBeispiel zum Testen und Debuggen eines verknüpften ProzessesEinführung in die Funktionsweise von Frends-APIsEinführung in die API-Spezifikation So verwenden Sie den Swagger Editor