Portal-Manager-Seite im Jitterbit API-Manager

Einführung

Die Portal-Manager-Seite ermöglicht es Ihnen, OpenAPI-Dokumentation für benutzerdefinierte und Proxy-APIs zu generieren. Die resultierende Dokumentation wird auf der Portal Seite angezeigt, wo Sie damit interagieren können, indem Sie APIs testen. Diese Seite beschreibt die Benutzeroberfläche der Portal-Manager-Seite im API-Manager.

Einschränkungen

Die Portal-Manager-Seite hat folgende Einschränkungen:

• Die Generierung von OpenAPI-Dokumentation für OData-Dienste wird nicht unterstützt.
• Die Generierung von OpenAPI-Dokumentation für API-Dienste, die eine benutzerdefinierte Anforderungsmethode verwenden, wird aufgrund einer Einschränkung der OpenAPI-Spezifikation nicht unterstützt. APIs, die nur benutzerdefinierte Methoden-API-Dienste enthalten, werden nur mit einem API-Tag-Namen angezeigt.
• In einer Harmony-Organisation kann nur eine einzige Portal-Seite für jede Umgebung erstellt werden.

Zugriff auf die Portal-Manager-Seite

Um auf die Portal-Manager-Seite zuzugreifen, verwenden Sie das Harmony-Portal-Menü, um API-Manager > Portal-Manager auszuwählen.

Kopfzeile der Portal-Manager-Seite

Die Portal-Manager-Seite wird auch als Entwicklerportal verwalten bezeichnet, da es die Seite ist, auf der Sie verwalten, was auf der Portal Seite angezeigt wird (auch als Entwicklerportal verwalten bezeichnet).

Diese Optionen erscheinen oben auf der Portal-Manager-Seite:

• Umgebung: Verwenden Sie das Menü, um die Umgebung auszuwählen, in der die OpenAPI-Dokumentation generiert und dann auf der Portal-Seite einer Organisation angezeigt wird.

  Um die Umgebungsübersicht zu aktualisieren, klicken Sie auf das Aktualisierungssymbol.

  Hinweis

  Es kann nur eine einzige Portal-Seite für jede Umgebung in einer Harmony-Organisation erstellt werden.

• API-Dokumentation anzeigen: Klicken Sie, um zur Portal Seite zu gelangen, auf der die generierte interaktive API-Dokumentation angezeigt wird.

• Dokumente regenerieren und veröffentlichen: Klicken Sie, um die OpenAPI 2.0-Dokumentation auf der Portal-Seite für alle benutzerdefinierten und Proxy-APIs in der ausgewählten Umgebung zu überschreiben und zu veröffentlichen. OData-Dienste sind ausgeschlossen. Wenn Sie eine neue benutzerdefinierte oder Proxy-API veröffentlicht haben und die Dokumentation automatisch regenerieren möchten, um neue APIs einzuschließen, müssen Sie diese Option verwenden.

  Warnung

  Die Verwendung dieser Option überschreibt die vorhandene API-Dokumentation, einschließlich aller Anpassungen. Es wird empfohlen, vor der Verwendung dieser Option eine manuelle Kopie der vorhandenen API-Dokumentation zu erstellen, indem Sie sie in einen externen Texteditor kopieren. Nach der Regenerierung der Dokumentation müssen Sie alle Anpassungen manuell wieder anwenden, indem Sie sie bei Bedarf in den API-Dokumentationseditor einfügen.

• Speichern und Veröffentlichen: Klicken Sie, um die API-Dokumentation auf der Portal-Seite zu speichern und zu veröffentlichen. Wenn Sie Anpassungen an der automatisch generierten API-Dokumentation vorgenommen haben, müssen Sie diese Option verwenden, um die Dokumentation auf der Portal-Seite zu veröffentlichen.

Portal-Seite anpassen

Die Portal Manager-Seite ermöglicht es Ihnen, die Portal Seite mit einem Bild, wie z.B. einem Firmenlogo, oder mit Änderungen an der automatisch generierten API-Dokumentation anzupassen:

• Lokale Dateien durchsuchen: Klicken Sie, um ein Bild auszuwählen, das den aufgeführten Anforderungen entspricht:

  

  Das hochgeladene Bild wird automatisch auf der Portal-Seite veröffentlicht, ohne dass Sie auf Dokumente regenerieren und veröffentlichen oder Speichern und Veröffentlichen klicken müssen.

  Um ein Bild nach dem Hochladen zu entfernen, klicken Sie auf Bild entfernen:

  

• Organisation: Die aktuell aufgerufene Harmony-Organisation.

• Basis-URL: Die Basis-URL für den API-Dienst. Klicken Sie auf das Kopiersymbol, um die Basis-URL in Ihre Zwischenablage zu kopieren.

API-Dokumentation bearbeiten

Interaktive Dokumentation, die der OpenAPI-Spezifikation 2.0 folgt, wird automatisch für alle benutzerdefinierten und Proxy-APIs in der ausgewählten Umgebung generiert.

Die OpenAPI-Definitionen werden im Editor auf der linken Seite der Seite angezeigt und als interaktive Swagger UI Dokumentation auf der rechten Seite der Seite gerendert.

Sie können die OpenAPI-Definitionen direkt im Editor auf der linken Seite der Seite bearbeiten. Dies sind Beispiele für Anpassungen der API-Dokumentation:

• Füllen Sie Metadaten zur API aus, einschließlich Fester Felder wie title, description, termsOfService, contact, license und version.

• Überschreiben Sie die Dokumentation manuell mit der OpenAPI-Spezifikation 3.0.

Nachdem Sie Änderungen an der API-Dokumentation vorgenommen haben, klicken Sie auf Speichern und Veröffentlichen, um die Dokumentation zu speichern und auf der Portal Seite zu veröffentlichen.

Um die Dokumentation nach der Veröffentlichung einer neuen API neu zu generieren und zu veröffentlichen, verwenden Sie die Schaltfläche Dokumente neu generieren und veröffentlichen.

Test-APIs

Die API-Dokumentation, die aus den OpenAPI-Definitionen generiert wird, die im Editor auf der linken Seite der Seite angezeigt werden, wird als interaktive Swagger UI Dokumentation auf der rechten Seite der Seite dargestellt. Sie können das interaktive Swagger verwenden, um die API-Dienste zu testen:

• Schemes: Verwenden Sie das Dropdown-Menü, um aus den verfügbaren Schemas auszuwählen, die von den OpenAPI-Definitionen unterstützt werden.

• Autorisieren: Wenn eine der APIs innerhalb der ausgewählten Umgebung eine Autorisierung erfordert, die durch ein zugewiesenes Sicherheitsprofil festgelegt wurde, wird eine Autorisieren-Schaltfläche angezeigt. Nach dem Klicken wird ein Dialogfeld angezeigt, das alle verfügbaren Autorisierungen anzeigt. Füllen Sie die Eingabe nach Bedarf aus, um APIs mit den bereitgestellten Autorisierungsmethoden zu testen.

  Nach dem Klicken auf Autorisieren wird ein Dialogfeld angezeigt, das alle verfügbaren Autorisierungen anzeigt. Füllen Sie die Eingabe nach Bedarf aus, um APIs mit den bereitgestellten Autorisierungsmethoden zu testen:

  

API-Dienste

Jeder API-Dienst wird mit seiner Methode aufgelistet:

Das Autorisierungssymbol zeigt an, ob der API-Dienst eine Autorisierung erfordert:

• : Es ist keine Autorisierung erforderlich.
• : Eine Autorisierung ist erforderlich.

Klicken Sie auf die Zeile des Endpunkts, um Informationen zu seinen Parametern und Antworten anzuzeigen – beschrieben unten.

Probieren Sie es aus

Klicken Sie bei einem erweiterten API-Dienst auf die Schaltfläche Probieren Sie es aus, um die API zu testen. Eine konfigurierbare API-Anfrage wird erweitert:

• Abbrechen: Klicken, um die konfigurierbare API-Anfrage zu minimieren.

• Ausführen: Sobald alle Anfragefelder konfiguriert sind, klicken, um die Curl und Anforderungs-URL zu generieren, die für Tests verwendet werden:

  

  • Curl: Die cURL-Anfrage für die eingegebenen Werte der API-Anfragefelder. Klicken Sie auf das Kopiersymbol, um die cURL in Ihre Zwischenablage zu kopieren.

  • Anforderungs-URL: Die Anforderungs-URL für die eingegebenen Werte der Anfragefelder.

• Zurücksetzen: Klicken, um die eingegebenen Werte für die API-Anfragefelder zu löschen.

Mögliche API-Antworten – die in der API-Dokumentation enthalten sind – werden für jeden API-Dienst angezeigt:

• Serverantwort: Zeigt alle dokumentierten Serverantworten an.

• Antworten: Zeigt dokumentierte HTTP-Statuscodes und deren Beschreibungen an.