Erstellen Sie den API-Workflow

Erstellen Sie einen erstellen

Schritt 1 – Erstellen des API-Workflows für die Explorer-Abfrage

Ein API-Workflow ist ein einfacher Workflow, der als API-Endpunkt veröffentlicht wurde. Sie erstellen eine, die die Open5e 5e SLD- Fensterdownload umschließt: eine Eingabe, eine HTTP-Anforderung, eine Ausgabe. Nach der Veröffentlichung wird es im Agent Builder als Tool angezeigt, das Ihr Agent aufrufen kann.

Dieser Schritt hat sechs Unterschritte. Budgeten Sie 10–15 Minuten für den Abschluss.

Erstellen Sie ein neues API-Workflow-Projekt

Wählen Sie in Ihrem Cloud-Arbeitsbereich die Option Neu erstellen . Wählen Sie im Dialogfeld Erstellung starten die Option API-Workflow unter Aufgabenautomatisierung aus.

Wenn Sie den Typ auswählen, wird das Projekt sofort ohne Namensaufforderung erstellt, sodass Sie es im nächsten Schritt umbenennen.

Die Lösung und den Standardworkflow umbenennen. Öffnen Sie das Kontextmenü für jeden Namen im Projekt-Explorer und wählen Sie Umbenennen aus:

• Lösungsname: Monster Query - 5e SRD
• Workflow-Name: API Query - 5e Monsters

Konfigurieren Sie Eingaben und Ausgaben

Wählen Sie den Data Manager (Zwischenablagesymbol neben der linken Leiste), um auf die Datenvariablen für den Workflow zuzugreifen.

Fügen Sie dem Workflow ein Eingabeargument hinzu:

Name	Typ	Erforderlich	Beschreibung
searchName	String	Ja	Der Maximalname oder ein Teilname, nach dem gesucht werden soll

Fügen Sie ein Ausgabeargument hinzu:

Name	Typ	Erforderlich	Beschreibung
monsterResults	Array	Ja	Server-Ergebnisliste

Fügen Sie die HTTP-Anforderung hinzu

1. Wählen Sie auf der Workflow-Arbeitsfläche + zwischen Aktivitäten aus, um das Aktivitätsmenü zu öffnen. Wählen Sie HTTP aus. Die Aktivität wird auf der Arbeitsfläche als HTTP Request angezeigt.
2. Öffnen Sie das Kontextmenü der Aktivität und wählen Sie Umbenennen aus. Nennen Sie sie HTTP Request - Open5e Monster Query.
3. Bestätigen Sie im Eigenschaftenbereich die Authentifizierung auf Manuelle Authentifizierung und auf GET als Methode. Beide sind die Standardeinstellungen einer neuen Aktivität, sodass normalerweise nichts geändert werden kann.
4. URL auf https://api.open5e.com/v2/creatures/ festlegen.
5. Benennen Sie die Aktivitätsausgabe in searchResults.

Legen Sie die Eigenschaft Abfrageparameter fest:

Öffnen Sie die Eigenschaft Abfrageparameter , die einen Wörterbuch-Editor mit den Spalten Schlüssel und Wert öffnet, und fügen Sie die folgenden Felder hinzu:

Schlüssel	Wert
name__icontains	Das Eingabeargument searchName – siehe Warnung unten
document__key	srd-2014
limit	10
fields	key,name,type,size,challenge_rating,alignment

Warnung:

name__icontains übernimmt die Variable searchName und Sie müssen sie aus der Variablenauswahl auswählen, anstatt sie einzugeben. Beginnen Sie im Wertfeld mit der Eingabe von @ , um die Auswahl zu öffnen, und wählen SiesearchName aus – wenn Sie die Auswahl nicht verwenden, wird die Eingabe als Literal-Zeichenfolge gesendet, und die API gibt HTTP 200 ohne Ergebnisse zurück. Das Feld stellt dann den Wert als Chip dar und der gespeicherte Wert ist $input.searchName.

Was die einzelnen Parameter bewirken:

• name__icontains: Teilweise Übereinstimmung ohne Groß-/Kleinschreibung; dragon gibt „Adult Red Dummy“, „Young Blue Dragon“ und andere zurück
• document__key: srd-2014: Filtert zur offiziellen 5e SSD; Ohne sie schließen die Ergebnisse jeden Herausgeber in der Datenbank ein, einschließlich Drittanbieterinhalte
• limit: 10: Begrenzt Kandidaten auf 10; genug für den Agent, ohne seinen Kontext zu überfluten
• fields: Beschränkt die Antwort auf die Felder, die der Agent benötigt; Das vollständige v2-Create-Objekt ist viel größer und würde das Token-Budget verschwenden

Warnung:

Open5e ignoriert Abfrageparameter, die es nicht erkennt, und gibt trotzdem HTTP 200 zurück. Falsch geschriebene document__key oder verwenden Sie die v1-Schreibweise document__slug, und der Filter wird im Hintergrund verworfen: Der Aufruf ist erfolgreich, die Ausführung ist grün und der Agent erhält Roboter von jedem Publisher anstelle des SLD. Eine goblin -Suche gibt 2 Ergebnisse mit dem angewendeten Filter und 29 ohne ihn zurück, also stellen Sie sicher, dass die Ergebnisanzahl wie eine Handvoll und nicht wie ein Katalog aussieht.

HTTP-Anforderungseigenschaftsreferenz

Die Aktivität macht die standardmäßigen HTTP-Strukturblöcke verfügbar. Die meisten konfigurieren Sie für jede API, die Sie aufrufen; einige werden Sie bei öffentlichen APIs wie dieser überspringen:

• Authentifizierung: Vorgefertigte Optionen für OAuth 2.0, API-Schlüssel und Standardauthentifizierung. Legen Sie hier „Manuelle Authentifizierung“ fest, da Open5e keine erfordert. Wählen Sie für authentifizierte APIs die entsprechende Option aus und geben Sie Anmeldeinformationen an.
• Header: Schlüssel/Wert-Paare, die mit jeder Anforderung gesendet werden. Wird häufig verwendet: Authorization: Bearer <token> für tokenbasierte APIs, Accept: application/json zum Steuern des Antwortformats und Header für die API-Versionierung.
• Textkörper: Wird mit POST-, PUT- und PATCH-Anforderungen verwendet, um JSON, Formulardaten oder Rohinhalte zu senden. Gilt nicht für GET-Anforderungen, die über Abfrageparameter Parameter in der URL übertragen.
• Abfrageparameter: Schlüssel/Wert-Paare an die URL angehängt. Um auf ein Workflow-Argument zu verweisen, geben Sie @ ein, um die Variablenauswahl zu öffnen, und wählen Sie das Argument aus – das Feld speichert $input.<name> und zeigt es als Chip an. @ ist das Triggerzeichen der Auswahl, keine Referenzsyntax, die Sie eingeben können. Weitere Informationen zu Variablen und Ausdrücken in Studio Web finden Sie unter Konfigurieren von Aktivitäten .
• Ausgabe (umbenannt in searchResults): Erhält die vollständige HTTP-Antwort einschließlich Statuscode, Header und Textkörper. Durch das Umbenennen im Standardwert bleibt der Antwortausdruck lesbar.

Fügen Sie die Antwort hinzu

1. Wählen Sie auf der Workflow-Arbeitsfläche die Option + nach der HTTP-Anforderung und dann Antwort aus.

   Die Aktivität Response definiert, was der API-Workflow an seinen Aufrufer zurückgibt (in diesem Fall, was das Tool des Agents erhält, wenn es den Workflow aufruft). Was auch immer Sie hier im Antworttext eingeben, wird zur Toolausgabe, über die der Agent argumentiert.

2. Legen Sie den Antworttext fest auf:

   {
     "monsterResults": $context.outputs.searchResults.content.results
   }
   

$context.outputs enthält jede benannte Ausgabe der Aktivitäten in diesem Workflow. searchResults ist die Ausgabevariable, die Sie für die Aktivität „HTTP Request“ umbenannt haben; .content.results navigiert in den Antwortumschlag, in den Open5e seine Daten umschließt, bis zum eigentlichen Array von Megainträgen. Weitere Informationen finden Sie in der UiPath-Dokumentation unter Verwenden von Javaskript für den Zugriff auf Workflowdaten.

Testen Sie den Workflow

1. Wählen Sie in der Symbolleiste die Option Debuggen .
2. Legen Sie im Eingabebereich searchName auf dragon oder goblin fest und führen Sie den Workflow aus.
3. Überprüfen Sie, ob die Antwort ein monsterResults -Array mit Array-Einträgen enthält, bevor Sie fortfahren.

Eine erfolgreiche Antwort enthält bis zu 10 Einträge mit jeweils key, name, alignment und challenge_rating sowie verschachtelten type - und size -Objekten. Die Suche in goblin gibt GoBins und Hobgo Lesen zurück. Wenn Sie ein leeres Array sehen, versuchen Sie es mit einem anderen Suchbegriff; Nicht jeder Credential-Name hat eine exakte Übereinstimmung im SSD.

In Ihrem Feed veröffentlichen

Beim Veröffentlichen wird der Workflow als bereitgestellter Prozess in Orchestrator registriert. Dadurch ist er in der Liste Verfügbare Ressourcen des Agent Builder auffindbar: Der Builder zeigt veröffentlichte Workflows aus Ihrem Arbeitsbereich an, keine Entwürfe, die lokal in Studio Web gespeichert sind.

1. Wählen Sie in der Symbolleiste die Option veröffentlichen aus.
2. Wählen Sie im Veröffentlichungsdialogfeld die Option Für mich aus, um in Ihrem persönlichen Arbeitsbereichsfeed zu veröffentlichen. Ein Feed für einen persönlichen Arbeitsbereich ist ein privates Paket-Repository, das an Ihren Orchestrator-Arbeitsbereich gebunden ist; Durch das Veröffentlichen von „Für mich“ ist dieser Workflow nur für Sie sichtbar, was der richtige Scope für die Entwicklung und das Testen ist. Weitere Informationen finden Sie unter Persönliche Arbeitsbereiche in der UiPath-Dokumentation.
3. Wählen Sie zum Bestätigen die Option Veröffentlichen .

Hinweis:

Workflow, der nicht in verfügbaren Ressourcen in Schritt 3 angezeigt wird? Der Workflow muss veröffentlicht (nicht nur gespeichert) werden, bevor er als Tool sichtbar ist. Wenn sie nicht angezeigt wird, kehren Sie hierher zurück, bestätigen Sie, dass die Veröffentlichung erfolgreich abgeschlossen wurde, und aktualisieren Sie dann den Agent Builder.

---

Sobald der Workflow veröffentlicht wurde, ist er im Agent Builder als verbundenes Tool im nächsten Abschnitt verfügbar.