Veröffentlichen eines API-Portals
Die API-Portal-Funktion in Talend Cloud API Designer ermöglicht Ihnen die Einrichtung eines API-Portals zur zentralen Verwaltung der Dokumentation für Ihre APIs, sodass Sie sie problemlos Ihren Nutzern bereitstellen können.
Auf der neuen Registerkarte API Portal (API-Portal) können Sie ein privates GitHub-Repository mit einer Vorlage für Ihr Portal erstellen. Anschließend können Sie Ihre API-Dokumentation mit einem Klick in dieses Repository übertragen.
Das auf dem statischen Website-Generator Hugo basierende Portal kann ganz einfach angepasst werden. So können Sie Ihr Logo und Farben in Übereinstimmung mit Ihrer Marke sowie neue Seiten für benutzerdefinierte Inhalte hinzufügen. Weitere Informationen zu Hugo finden Sie in der Hugo-Dokumentation. Die neueste unterstützte Hugo-Version ist v0.145.0.
Sobald Sie Ihr Portal konfiguriert haben, können Sie das Portal im Ziel Ihrer Wahl implementieren. Einige Beispiele für die Implementierung eines Portals in unterschiedlichen Zielen finden Sie unter Deploying your portal.
Voraussetzungen für das API-Portal
- Eine Rolle mit der Berechtigung API Portal - Create and edit (API-Portal - Erstellen und bearbeiten). Diese Berechtigung ist in der vordefinierten Rolle API Portal Publisher (API-Portal-Herausgeber) verfügbar und kann ebenfalls zu einer anderen Rolle hinzugefügt werden. Benutzerrollen und Berechtigungen können von einem Security Administrator (Sicherheitsadministrator) in Talend Management Console geändert werden. Weitere Informationen finden Sie unter Verwalten von Regeln.
- Ein GitHub-Konto mit der Berechtigung, ein privates Repository zu erstellen bzw. darin zu schreiben. Wenn Sie eine Veröffentlichung auf GitHub Pages planen, benötigen Sie einen GitHub-Plan, der Ihnen die Veröffentlichung aus einem privaten Repository ermöglicht.