Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

API-Dokumentation

Talend Cloud API Designer ermöglicht Ihnen die Dokumentierung Ihrer API. Die Erstellung einer Dokumentation ist ein wichtiger Schritt innerhalb des Lebenszyklus einer API. Die Verfassung und Verwaltung einer Dokumentation können sich als schwierig erweisen, deshalb ermöglicht Ihnen Talend Cloud API Designer die automatische Erstellung Ihrer Dokumentation.

Wer liest und wer schreibt die Dokumentation?

In Talend Cloud API Designer arbeitet ein Team von API-Designern gemeinsam an der Gestaltung und Bearbeitung Ihrer API. Die Teammitglieder können eigene Beiträge zur API-Dokumentation hinzufügen und eine Live-Vorschau generieren.

Die Live-Dokumentation kann während ihrer Erstellung für die Mitglieder des Teams, für Partner und für alle, die eventuell Zugriff darauf benötigen, freigegeben werden.

Sobald Ihre API-Dokumentation fertig gestellt ist, können Sie sie auf Ihrem API-Portal veröffentlichen. Weitere Informationen finden Sie unter Publishing an API Portal.

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!