Zu Hauptinhalt springen

Antwortgenerierung mit API-Mocks

Sobald Sie einen API-Mock aktiviert haben, kann dieser direkt verwendet werden.

API-Mocks beantworten alle empfangenen Aufrufe so realistisch wie möglich. Bei der Generierung eines Antwort-Bodys berücksichtigt ein Mock prioritär die vom Benutzer bereitgestellten Daten und sucht nach einem Beispielfeld, dann nach einem Standardwert und schließlich nach einem Enum-Feld. Wird ein derartiges Feld bzw. ein derartiger Wert gefunden, dann wird es bzw. er als Beispiel verwendet. Andernfalls wird auf der Grundlage des von der aufgerufenen Operation zurückgegebenen Datentyps ein JSON-Beispiel generiert.

Die nachstehend gezeigte Definition des Datentyps „Company“ fungiert als Beispiel. Sie enthält keine vom Benutzer bereitgestellten Beispiele.

Die Datentypdefinition Company (Unternehmen) ohne Beispiele.

Bei aktiviertem Mocking wird bei einem GET-Aufruf an die Ressource /company/{companyId} eine automatisch generierte JSON-Antwort basierend auf der Struktur des Datentyps zurückgegeben, mithilfe von Talend Cloud API Tester wie nachstehend gezeigt.

Antwortbeispiel.

Der Mock hat eine Reihe interessanter Aktionen ausgeführt, u. a. die Generierung von Werten für benutzerspezifische Antwort-Header (z. B. x-my-custom-header), die Identifizierung von Arrays und die Erstellung geeigneter Beispiele (z. B. Tags-Eigenschaft) sowie die Identifizierung verschachtelter Strukturen und die Generierung von Werten für diese (z. B. Adresseigenschaft).

Mocks von Talend Cloud API Designer unterstützen die Content Negotiation, sodass Sie den „Accept“-Request-Header verwenden können, um unter verschiedenen Optionen (wobei jede Option potenziell über ein eigenes Beispiel verfügt) den Body auszuwählen, der zurückgegeben werden soll. Dadurch werden die vom Mock zurückgegebenen Beispiele geändert.

Beispiel für Contact (Kontakt).
InformationshinweisAnmerkung: Beim Aufrufen eines API-Mocks kann die Schreibung der Antwort-Header-Namen geändert werden. Das dürfte keine Probleme verursachen, da bei HTTP-Header-Namen nicht zwischen Groß- und Kleinschreibung unterschieden wird.

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!