Definieren allgemeiner API-Informationen

Bearbeiten Sie die allgemeinen Informationen zu Ihrer API-Version und definieren Sie die zugehörigen Medientypen, Server-URLS und Sicherheitsschemas.

Prozedur

Navigieren Sie zur allgemeinen Informationsseite der API.
Diese Seite wird nach der Erstellung der API automatisch geöffnet. Sie können sie auch durch Klicken auf den Namen der API am oberen Rand des linken Fensterbereichs öffnen.
Bearbeiten Sie im Abschnitt General (Allgemein) die Version, die Beschreibung, die Kontakt- und Lizenzinformationen sowie die Servicebedingungen für Ihre API.

InformationshinweisAnmerkung: Der Name der API kann über die Homepage von Talend Cloud API Designer geändert werden. Weitere Informationen finden Sie unter Renaming an API.
Bearbeiten Sie den Abschnitt Media types (Medientypen), um Medientypen hinzuzufügen oder zu entfernen.
Die in diesem Abschnitt definierten Medientypen sind von globaler Gültigkeit, d. h. sie werden auf die gesamte API-Version angewendet. Sie können ebenfalls auf Operationsebene definiert werden.
Fügen Sie im Abschnitt Server URLs Ihre Server-URLs hinzu.
Die in diesem Abschnitt definierten Server-URLs sind von globaler Gültigkeit, d. h. sie werden auf die gesamte API-Version angewendet. Nach ihrer Definition werden die Server-URLs unter dem Namen der API am oberen Rand des linken Fensterbereichs zusammen mit dem Mock-Endpunkt angezeigt, sofern aktiviert.
Veröffentlichte Server-URLs werden in der Live-Dokumentation und im Portal angezeigt. Die erste veröffentlichte Server-URL wird auch beim Testen der API in Talend Cloud API Tester verwendet. Weitere Informationen finden Sie unter Trying your API in Talend Cloud API Tester. Nicht veröffentlichte Server-URLs werden nur in Talend Cloud API Designer angezeigt.

InformationshinweisAnmerkung: Wenn mehrere Server-URLs vorhanden sind, wird beim Test der API in Talend Cloud API Tester standardmäßig die erste URL in der Liste verwendet.
Definieren Sie die Sicherheit für die API in den Abschnitten Global security (Globale Sicherheit) und Security schemes (Sicherheitsschemas).
Die in diesem Abschnitt definierte Sicherheit ist von globaler Gültigkeit, d. h. sie wird auf die gesamte API-Version angewendet. Sie kann ebenfalls auf Ressourcen- und Operationsebene definiert werden.

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!

Geben Sie hier Ihr Feedback ab