Verwalten 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 die Live-Dokumentation nicht aktiviert ist, kann sie von Benutzern, die über einen Zugriff auf die API-Definition verfügen, nur als Vorschau angezeigt werden. Dies wird auf der Schaltfläche Live Documentation (Live-Dokumentation im Header ausgewiesen.

1. Rufen Sie die Seite Settings (Einstelllungen) auf.
   Der Zugriff auf diese Seite erfolgt durch Auswahl von Edit (Bearbeiten) > Settings (Einstellungen) bzw. durch Klicken auf Settings (Einstellungen) im linken Fensterbereich.
2. Ändern Sie die Option Enabled (Aktiviert) von Off (Aus) zu On (Ein) und geben Sie eine URL ein.

   

3. Wählen Sie die Sichtbarkeit aus. Wenn Sie Password protected (Passwortgeschützt) auswählen, müssen Sie ein Passwort in das entsprechende Feld eingeben.
4. 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 Sie Ihre Dokumentation und legen Sie fest, ob die zugehörige Subdomain beibehalten werden soll.

1. Öffnen Sie Ihre API und gehen Sie zu Settings (Einstellungen).
2. Ändern Sie die Option Enabled (Aktiviert) von On (Ein) zu Off (Aus).
3. 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.

   

4. Klicken Sie auf Save (Speichern).