Verwalten der Live-Dokumentation

Aktivieren der Live-Dokumentation

Wenn Sie Ihre API-Dokumentation für Personen freigeben möchten, die nicht zu Ihrem Team gehören, müssen Sie die Live-Dokumentationsfunktion aktivieren.

Solange sie nicht aktiviert ist, kann sie von Benutzern, die über Zugriff auf die API-Definition verfügen, nur als Vorschau angezeigt werden.

Prozedur

Gehen Sie zur Seite Settings (Einstellungen) der API, indem Sie auf Edit (Bearbeiten) > Open API settings (API-Einstellungen öffnen) klicken.
Ändern Sie die Option Enabled (Aktiviert) von Off (Aus) zu On (Ein) und geben Sie eine URL ein.
Wählen Sie die Sichtbarkeit aus. Wenn Sie Password protected (Passwortgeschützt) auswählen, müssen Sie ein Passwort in das entsprechende Feld eingeben.
Klicken Sie auf Save (Speichern), um die Live-Dokumentation zu aktivieren.

Ergebnisse

Ihre Live-Dokumentation ist jetzt verfügbar. Sie können auf Open (Öffnen) klicken, um sie in einer neuen Registerkarte zu öffnen.

Deaktivieren der Live-Dokumentation

Deaktivieren Sie Ihre Dokumentation und legen Sie fest, ob die zugehörige Subdomain beibehalten werden soll.

Prozedur

Öffnen Sie Ihre API und gehen Sie zu Open API settings (API-Einstellungen öffnen).
Ändern Sie die Option Enabled (Aktiviert) von On (Ein) zu Off (Aus).
Wenn Sie die Subdomain der Dokumentation freigeben möchten, deaktivieren Sie das Kontrollkästchen Retain Live API documentation subdomain (Subdomain der Live-API-Dokumentation beibehalten).
Standardmäßig speichert Talend Cloud API Designer die Subdomain, die Sie bei der Aktivierung der Live-Dokumentation definiert haben. Dadurch wird dieselbe URL beibehalten, wenn Sie die Dokumentation zu einem späteren Zeitpunkt erneut aktivieren möchten. Wenn Sie die Subdomain für eine andere API verwenden möchten, müssen Sie sie zuerst freigeben.
Klicken Sie auf Save (Speichern).

Ergebnisse

Ihre Live-Dokumentation ist damit deaktiviert. Wenn Sie die Subdomain beibehalten haben, können Sie sie jederzeit erneut aktivieren. Andernfalls kann die Subdomain von einer anderen API verwendet werden. In diesem Fall müssen Sie eine Subdomain eingeben, wenn Sie die Dokumentation erneut aktivieren möchten.

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