Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

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 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.

Schaltfläche Live Documentation (Live-Dokumentation) im Header.

Prozedur

  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.
    Konfiguration der Live-Dokumentation.
  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.

Screenshot der Live-Dokumentation für die Petstore API.

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