Portal Manager-Seite im Jitterbit API-Manager

Einführung

Auf der Seite Portal Manager können Sie OpenAPI-Dokumentation für benutzerdefinierte und Proxy-APIs generieren. Die resultierende Dokumentation wird im Portal angezeigt, auf der Sie durch Testen von APIs damit interagieren können. Diese Seite beschreibt die Benutzeroberfläche der Portal Manager-Seite im API-Manager.

Einschränkungen

Für die Seite Portal Manager gelten die folgenden Einschränkungen:

• Generierung von OpenAPI-Dokumentation für OData Dienste wird nicht unterstützt.
• Generierung von OpenAPI-Dokumentation für API Dienste mithilfe einer benutzerdefinierten Anforderungsmethode 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 für jede Umfeld nur eine einzige Portal-Seite erstellt werden.

Greifen Sie auf die Portal Manager-Seite zu

Um auf die Seite Portal Manager zuzugreifen, wählen Sie im Harmony-Portalmenü API-Manager > Portal Manager aus:

Header des Portal Managers

Die Seite Portalmanager wird auch Entwicklerportal verwalten genannt, da Sie hier die Anzeige im Portal verwalten können Seite (auch Entwicklerportal verwalten genannt).

Diese Optionen werden oben auf der Seite Portal Manager angezeigt:

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

  Um die Umfeld zu aktualisieren, klicken Sie auf das Aktualisierungssymbol.

  Notiz

  In einer Harmony Organisation kann für jede Umfeld nur eine einzige Portal-Seite erstellt werden.

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

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

  Warnung

  Mit dieser Option wird die vorhandene API Dokumentation einschließlich aller Anpassungen überschrieben. Es wird empfohlen, vor der Verwendung dieser Option eine manuelle Kopie der vorhandenen API Dokumentation zu erstellen, indem Sie diese in einen externen Texteditor kopieren. Nach der Neuerstellung der Dokumentation wenden Sie alle Anpassungen manuell erneut an, indem Sie sie entsprechend in den API Dokumentationseditor einfügen.

• Speichern und veröffentlichen: Klicken Sie hier, um die API Dokumentation zu speichern und auf der Portalseite 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 Portalseite zu veröffentlichen.

Anpassen der Portalseite

Auf der Seite Portalmanager können Sie das Portal anpassen Seite mit einem Bild wie beispielsweise einem Firmenlogo oder mit Änderungen an der automatisch generierten API Dokumentation:

• Lokale Dateien durchsuchen: Klicken Sie hier, um ein Bild auszuwählen, das die aufgeführten Anforderungen erfüllt:

  

  Das hochgeladene Bild wird automatisch auf der Portal-Seite veröffentlicht, ohne dass Sie auf Dokumente neu generieren 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 Harmony-Organisation, auf die aktuell zugegriffen wird.

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

Bearbeiten der API Dokumentation

Interaktive Dokumentation gemäß der OpenAPI-Spezifikation 2.0 wird automatisch für alle benutzerdefinierten und Proxy-APIs in der ausgewählten Umfeld 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.

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

• Füllen Sie Metadaten zur API aus, einschließlich Feste Felder wie zum Beispiel title, description, termsOfService, contact, license, Und version.

• Manuelles Überschreiben der Dokumentation mithilfe 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 im Portal zu veröffentlichen Seite.

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 aus den OpenAPI-Definitionen generierte API Dokumentation wird im Editor auf der linken Seite der Seite als interaktive Swagger UI dargestellt Dokumentation auf der rechten Seite. Sie können den interaktiven Swagger verwenden, um die API Dienste zu testen:

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

• Autorisieren: Wenn eine der APIs in der ausgewählten Umfeld eine Autorisierung erfordert, die durch ein zugewiesenes Sicherheitsprofil wird die Schaltfläche Autorisieren angezeigt. Nach dem Klicken werden alle verfügbaren Autorisierungen in einem Dialogfeld angezeigt. Vervollständigen Sie die erforderlichen Eingaben, um APIs mit den bereitgestellten Autorisierungsmethoden zu testen.

  Wenn Sie auf Autorisieren klicken, werden in einem Dialogfeld alle verfügbaren Autorisierungen angezeigt. Vervollständigen Sie die Eingaben nach Bedarf, um APIs mit den bereitgestellten Autorisierungsmethoden zu testen:

  

API -Dienste

Jeder API Dienst wird mit seiner Methode aufgelistet:

Das Autorisierungssymbol zeigt an, ob für den API Dienst eine Autorisierung erforderlich ist:

• : Keine Autorisierung erforderlich.
• : Autorisierung ist erforderlich.

Klicken Sie auf die Endpoint, um Informationen zu den Parametern und Antworten anzuzeigen - unten beschrieben.

Probieren Sie es aus

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

• Abbrechen: Klicken Sie hier, um die konfigurierbare API Anfrage auszublenden.

• Ausführen: Sobald alle Anforderungsfelder konfiguriert sind, klicken Sie, um die Curl- und Anforderungs URL zu generieren, die zum Testen verwendet werden soll:

  

  • Curl: Die cURL-Anfrage für die in den API Anfragefeldern eingegebenen Werte. Klicken Sie auf das Kopieren-Symbol, um die cURL in Ihre Zwischenablage zu kopieren.

  • Anforderungs URL: Die Anforderungs URL für die in die Anforderungsfelder eingegebenen Werte.

• Löschen: Klicken Sie hier, um die für die API Anforderungsfelder eingegebenen Werte zu löschen.

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

• Serverantwort: Zeigt alle dokumentierten Serverantworten an.

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