Verwalten der Live-Dokumentation | Qlik Cloud Hilfe
Zu Hauptinhalt springen Zu ergänzendem Inhalt springen
Qlik Ressourcen
SearchUnify-Suche wird geladen Wenn Sie Unterstützung für Ihr Produkt benötigen, wenden Sie sich an den Qlik-Support.
Qlik Kundenportal
SearchUnify-Suche wird geladen Wenn Sie Unterstützung für Ihr Produkt benötigen, wenden Sie sich an den Qlik-Support.
Qlik Kundenportal

Verwalten der Live-Dokumentation

Aktivieren der Live-Dokumentation

Um Ihre API-Dokumentation mit Personen zu teilen, die nicht in Ihrem Team sind, müssen Sie die Funktion „ Live-Dokumentation“ aktivieren.

Solange sie nicht aktiviert ist, ist sie nur als Vorschau für Benutzer sichtbar, die Zugriff auf die API-Definition haben.

  1. Gehen Sie zur Seite Einstellungen der API, indem Sie auf Bearbeiten > API-Einstellungen öffnen klicken.
  2. Schalten Sie die Schaltfläche Aktiviert von Aus auf Ein und geben Sie eine URL ein.
    Konfiguration der Live-Dokumentation.
  3. Wählen Sie die Sichtbarkeit. Wenn Sie Kennwortgeschützt auswählen, geben Sie ein Kennwort in das entsprechende Feld ein.
  4. Klicken Sie auf Speichern, um die Live-Dokumentation zu aktivieren.

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

Deaktivieren der Live-Dokumentation

Deaktivieren Sie die Dokumentation und wählen Sie aus, ob Sie deren Subdomäne beibehalten möchten.

  1. Öffnen Sie die API und gehen Sie zu API-Einstellungen öffnen.
  2. Schalten Sie die Schaltfläche Aktiviert von Aus auf Ein und geben Sie eine URL ein.
  3. Wenn Sie die Dokumentations-Subdomäne freigeben möchten, deaktivieren Sie das Kontrollkästchen Live-API-Dokumentations-Subdomäne beibehalten.
    Standardmäßig speichert API Designer die Subdomäne, die Sie beim Aktivieren der Live-Dokumentation definiert haben. Dadurch können Sie dieselbe URL beibehalten, wenn Sie sie später erneut aktivieren. Wenn Sie diese Subdomäne für eine andere API verwenden möchten, müssen Sie sie zuerst freigeben.
    Konfiguration der Live-Dokumentation.
  4. Klicken Sie auf Speichern.
Die Live-Dokumentation ist deaktiviert. Wenn Sie die Subdomäne beibehalten haben, können Sie sie jederzeit wieder aktivieren. Andernfalls kann die Subdomäne von einer anderen API verwendet werden, und Sie müssen eine Subdomäne eingeben, wenn Sie diese 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