Definieren allgemeiner API-Informationen

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

Prozedur

Rufen Sie die allgemeine Informationsseite auf.
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.
Klicken Sie auf das Stiftsymbol links neben der Section GENERAL (ALLGEMEIN), um die Version, die Beschreibung, die Kontakt- und Lizenzinformationen sowie die Servicebedingungen für Ihre API zu bearbeiten.

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 die Section MEDIA TYPES (MEDIENTYPEN) und fügen Sie Medientypen hinzu bzw. entfernen Sie sie.
Die in dieser Section 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 Ihre Endpunkte in der Section ENDPOINTS (ENDPUNKTE) hinzu.
Die in dieser Section definierten Endpunkte sind von globaler Gültigkeit, d. h. sie werden auf die gesamte API-Version angewendet. Nach ihrer Definition werden die Endpunkte unter dem Namen der API am oberen Rand des linken Fensterbereichs gemeinsam mit dem Mock-Endpunkt angezeigt, sofern aktiviert.
Veröffentlichte Endpunkte werden in der Live-Dokumentation und im Portal angezeigt. Der erste veröffentlichte Endpunkt wird zudem beim Test der API in Talend Cloud API Tester verwendet. Weitere Informationen finden Sie unter Trying your API in Talend Cloud API Tester. Nicht veröffentlichte Endpunkte werden nur in Talend Cloud API Designer angezeigt.

InformationshinweisAnmerkung: Wenn mehrere Endpunkte vorhanden sind, wird beim Test der API in Talend Cloud API Tester standardmäßig der erste Endpunkt in der Liste verwendet. Sie können einen Endpunkt in der Liste verschieben, indem Sie auf die Leiste links neben der URL klicken und den Endpunkt an eine Position ober- oder unterhalb ziehen.
Definieren Sie die Sicherheit für die API in den Sections GLOBAL SECURITY (GLOBALE SICHERHEIT) und SECURITY SCHEMES (SICHERHEITSSCHEMAS).
Die in dieser Section 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.
Klicken Sie auf Save (Speichern).

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