Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

Verwalten der API-Dokumentation

Veröffentlichen und aktualisieren Sie Ihre API-Dokumentation und heben Sie deren Veröffentlichung wieder auf.

Warum und wann dieser Vorgang ausgeführt wird

Über die Liste der APIs auf der Registerkarte API Portal (API-Portal) können Sie die in Ihrem Repository veröffentlichte API-Dokumentation verwalten.
Registerkarte API Portal.

Prozedur

  • Um eine neue API-Version auf dem Portal zu veröffentlichen, klicken Sie auf die Schaltfläche Publish (Veröffentlichen).
  • Um eine bereits veröffentlichte Dokumentation erneut zu veröffentlichen, klicken Sie auf die Schaltfläche Republish (Erneut veröffentlichen).
  • Wenn eine API seit ihrer letzten Veröffentlichung geändert wurde, klicken Sie auf die Schaltfläche Update (Aktualisieren), um die aktualisierte Dokumentation an Ihr Repository zu senden.
    Wenn die neuesten Änderungen veröffentlicht wurden, wird neben dem Datum der letzten Aktualisierung folgendes Symbol angezeigt: Symbol „Up to date (Aktualisiert)“. Wenn die API-Definition seit der letzten Veröffentlichung aktualisiert wurde, wird folgendes Symbol angezeigt: Symbol „Not up to date (Nicht aktualisiert)“.
  • Um eine API-Version aus dem Repository zu entfernen, klicken Sie auf Unpublish (Veröffentlichung aufheben).
  • Um eine API-Version als veröffentlicht zu kennzeichnen, ohne sie an das Repository zu übertragen, klicken Sie auf die Schaltfläche Menu (Menü) und anschließend auf Mark as published (Als veröffentlicht markieren).
  • Um eine API-Version als unveröffentlicht zu kennzeichnen, ohne sie aus dem Repository zu löschen, klicken Sie auf die Schaltfläche Menu (Menü) und anschließend auf Mark as unpublished (Als unveröffentlicht markieren).

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!