Erstellen und konfigurieren Sie ein Tool

Beginnen Sie mit der offiziellen API-Dokumentation für den Unternehmensdienst und einer Aufgabe, die Ihr Konto ausführen darf. Ein eng gefasstes, gut beschriebenes Tool ist einfacher zu testen als ein generisches Tool, das eine beliebige URL und Methode akzeptiert.

Definieren Sie die Anfrage#

Geben Sie dem Tool einen stabilen Namen und eine Beschreibung, die seinen Zweck, wichtige Einschränkungen und ob es Daten ändert, erläutert. Wählen Sie die dokumentierte HTTP-Methode und den Endpunkt aus. Verwenden Sie Platzhalter nur für die variablen Pfadelemente, die der Vorgang tatsächlich zulässt.

Bei einer fiktiven Datensatzsuche kann der Pfad eine Datensatzkennung enthalten. Der Hostname und die Kontoregion sollten Teil der konfigurierten Verbindung bleiben und keine offene Modelleingabe sein.

Eingaben definieren und zuordnen#

Verwenden Sie das Eingabeschema, um jedes Feld, seinen Typ, den erforderlichen Status und die gültigen Werte zu beschreiben. Ein kleines Schema für eine fiktive Suche ist:

{
  "type": "object",
  "properties": {
    "record_id": {
      "type": "string",
      "description": "The verified identifier of the record to read"
    }
  },
  "required": ["record_id"],
  "additionalProperties": false
}

Ordnen Sie Argumente den dokumentierten Pfad-, Abfrage- oder Textfeldern zu. Überprüfen Sie, ob fehlende Pflichtfelder und unerwartete zusätzliche Argumente eindeutig fehlschlagen. Behalten Sie die Authentifizierung in der unterstützten Serververbindung bei, nicht in einer Eingabeaufforderung, einem Beispielschema oder einem hartcodierten Tool-Header.

Gestalten Sie die Ausgabe#

Die Antwortzuordnung oder -transformation kann anstelle einer gesamten Serviceantwort die Felder zurückgeben, die der Workflow benötigt. Überprüfen Sie die transformierte Ausgabe anhand des ursprünglichen Testergebnisses. Entfernen Sie nicht die Datensatzkennung, Paginierungsinformationen oder Fehlerdetails, die erforderlich sind, um zu verstehen, ob das Ergebnis vollständig ist.

Überprüfen Sie die Betriebseinstellungen#

Die Toolkonfiguration unterstützt Timeout-, Caching- und Wiederholungseinstellungen. Verwenden Sie Caching nur, wenn veraltete Daten akzeptabel sind. Ein zwischengespeicherter Lesevorgang eignet sich nicht als endgültiger Beweis dafür, dass ein Schreibvorgang gerade abgeschlossen wurde. Der Wiederholungsversuch eines nicht idempotenten Schreibvorgangs kann zu Duplikaten führen. Wählen Sie daher das Wiederholungsverhalten aus den dokumentierten Garantien der API aus.

Testen Sie den wahren Weg#

Überprüfen Sie korrekte Eingaben, ungültige Eingaben, leere Ergebnisse, Berechtigungsfehler und einen begrenzten erfolgreichen Aufruf. Testdiagnosen können vertrauliche Anforderungsinformationen enthalten; Überprüfen Sie sie nur über den genehmigten Administratorweg und redigieren Sie sie vor der Freigabe. Sehen testen bevor ein Kunde das Tool verwendet.