Zu Hauptinhalt springen

Verwenden von Beispielen

Fügen Sie in Ihrer gesamten API Beispieldaten in Beispielfeldern hinzu.

In Talend Cloud API Designer können Sie Beispielwerte für verschiedene Elemente der API hinzufügen. Sobald Sie ein Beispiel definiert haben, wird dieses verwendet, wenn Sie API-Aufrufe an Ihren Mock ausgeben.

Im folgenden Beispiel wurde ein Datentyp unter Rückgriff auf ein Beispiel erstellt.

Screenshot des Datentyps Character (Rolle), der anhand eines JSON-Beispiels generiert wurde.

Dieser Datentyp wird dann als Antwort-Body für eine Operation verwendet.

Der Datentyp Character (Rolle) wird für die Methode mit dem Namen Get a Star Wars character by ID (Star Wars-Rolle nach ID abrufen) verwendet.

Beim Test der Operation in Talend Cloud API Tester wird das Beispiel als Antwort zurückgegeben.

Antwort mit dem Rollenbeispiel. Hier ist die Rolle Luke Skywalker.

Sie können Beispiele in verschiedenen Teilen Ihrer API definieren, wobei bei der Ausgabe von Aufrufen an Ihren Mock einige davon ggf. durch andere überschrieben werden. Nachstehend wird das Beispiel des Datentyps verwendet, Sie können jedoch ebenfalls ein Beispiel für die Antwort der Operation definieren.

Ein neues Beispiel wird für die Antwort definiert. Hier ist die Rolle Leia Organa.

Beim Test der Operation in Talend Cloud API Tester erhält das in der Operation bereitgestellte Beispiel Vorrang vor dem im Datentyp definierten Beispiel.

Die Rolle in der Beispielantwort ist jetzt Leia Organa.

In einem Datentyp können Sie ein Beispiel für das gesamte Objekt oder aber für einzelne Eigenschaften definieren. Wenn Sie beides verwenden, wird beim Test des Mocks das für das gesamte Objekt verwendete Beispiel zurückgegeben.

Externe Beispiele werden nicht unterstützt.

Hat diese Seite Ihnen geholfen?

Wenn Sie ein Problem mit dieser Seite oder ihrem Inhalt feststellen, sei es ein Tippfehler, ein ausgelassener Schritt oder ein technischer Fehler, informieren Sie uns bitte!