Veröffentlichen einer API

Online bearbeiten

Die Benutzerschnittstelle bietet eine Option, mit der eine API zu einem Produkt hinzugefügt und das Produkt in einem Katalog veröffentlicht wird. Durch die Veröffentlichung eines Produktentwurfs werden die APIs dieses Produkts im Verbraucherkatalog für Anwendungsentwickler sichtbar gemacht. Die Syndikationsfunktion in IBM® API Connect bedeutet, dass Produkte, sofern Spaces für einen Katalog aktiviert sind, nur in einem Space innerhalb dieses Katalogs veröffentlicht werden können.

Vorbereitende Schritte

Stellen Sie sicher, dass Sie über einen Katalog zum Bereitstellen in den Benutzerschnittstellen von API Manager oder API Designer verfügen. Weitere Informationen finden Sie unter Erstellen und Konfigurieren von Katalogen.

Stellen Sie sicher, dass für den Katalog mindestens ein Gateway-Service konfiguriert ist.

Hinweis: Alle Verweise in diesem Thema auf einen Katalog können auch auf Bereiche (Spaces) in einem Katalog angewendet werden, sofern nicht anders angegeben. Weitere Informationen zu Spaces finden Sie unter „Verwendung von Syndication in API Connect…“.

Um die in diesem Thema beschriebenen Aufgaben im Bereich Produktmanagement ausführen zu können, müssen Sie entweder Eigentümer der API-Anbieterorganisation sein oder über die Berechtigung „Produkt > Verwalten“ für den Zielkatalog oder den Zielbereich verfügen. Informationen zum Konfigurieren von Produktverwaltungsberechtigungen für einen Katalog oder -Bereichfinden Sie unter Erstellen und Konfigurieren von Katalogen oder Benutzerzugriff in einem Bereich verwalten.

Informationen zu dieser Task

Sie können diese Task entweder mithilfe der UI-Anwendung API Designer oder mithilfe der browserbasierten Benutzerschnittstelle von API Manager ausführen. Die Veröffentlichung ist nicht verfügbar, wenn Sie offline in API Designer arbeiten.

Die Validierung der API-Definitionsdatei erfolgt während des Staging-oder Veröffentlichungsprozesses. Die folgende Validierung erfolgt:
  • Validierung anhand des OpenAPI -Schemas mithilfe des Swagger-Parsers für API-Entwicklungstools (https://www.npmjs.com/package/@apidevtools/swagger-parser).
  • Validierung anhand der IBM Erweiterungseigenschaften.
  • Semantische Validierung; diese umfasst die folgenden Validierungstypen:
    • Wenn eine OpenAPI von einem API Connect Gateway erzwungen wird, muss das Schema HTTPS sein, oder der Parametername für ein API-Schlüssel-Sicherheitsschema im Header muss entweder X-IBM-Client-Id oder X-IBM-Client-Secret lauten.
    • Wenn OpenAPI nicht von einem API Connect Gatewayerzwungen wird, muss ein Host angegeben werden.
    • Verweisen Sie auf lokale Referenzen in der Definitionsdatei (d. h. auf Werte von $ref -Eigenschaften) und stellen Sie sicher, dass diese gültige JSON-Zeiger in der Datei sind.
Hinweis: Produkte, die eine API mit einer Swagger-Eigenschaft mit regex enthalten, die Lookahead-Zusicherungen wie "(?" enthalten, können nicht validiert oder veröffentlicht werden. Es wird eine Fehlernachricht zurückgegeben. Beispiel: 
Product has not been published!
The multipart 'openapi' field contains an OpenAPI definition with validation errors.
    definitions.properties.pattern Does not match format 'regex' (context: (root).definitions.properties.pattern, line: 0, col: 0)
400
Hinweis: Wenn die Datei OpenAPI , die Ihre API definiert, ein Feld $ref verwendet, um auf ein Fragment von OpenAPI -Code zu verweisen, der in einer separaten Datei definiert ist, wird das Feld $ref durch den Inhalt der Zieldatei ersetzt, bevor das Produkt, das die API enthält, bereitgestellt oder veröffentlicht wird (das Feld $ref wird nur unterstützt, wenn Sie das API Connect Developer Toolkitverwenden). Weitere Informationen finden Sie unter Verwenden von $ref zur Wiederverwendung von Codefragmenten in Ihren OpenAPI -Dateien.

Vorgehensweise

  1. Klicken Sie im Navigationsbereich auf Symbol 'Entwickeln' im Navigationsfenster „Entwickeln “ und wählen Sie dann die Registerkarte „APIs“ aus.
    Die Seite Entwickeln wird angezeigt.
  2. Optional: Wenn Sie über Konten für mehrere Provider-Organisationen verfügen, können Sie im Menü Organisation eine neue Provider-Organisation für die Bereitstellung und Veröffentlichung auswählen.
  3. Sie können eine API über die Listenseite Entwickeln oder über die API-Definition selbst veröffentlichen.
    1. Um eine API über die Seite „Develop “ zu veröffentlichen, klicken Sie auf das Optionsmenü-Symbol Symbol für Optionen neben der gewünschten API und wählen Sie dann „Veröffentlichen “.
    2. Führen Sie die folgenden Schritte durch, um eine API aus der API-Definition heraus zu veröffentlichen:
      1. Klicken Sie auf den Titel der API, mit der Sie arbeiten möchten.
      2. Klicken Sie auf der Seite Develop auf das Menüsymbol (drei Punkte) neben der API, die Sie bearbeiten möchten, und klicken Sie dann auf Edit API.
      3. Klicken Sie auf die Registerkarte „Test“ und wählen Sie dann „Zielkonfiguration“ aus.

        Das Dialogfeld „Einstellungen“ wird angezeigt.

      4. Setzen Sie die Option „Automatisch veröffentlichen“ auf „Ein “.
      Zur Erinnerung: Die Einstellung für die automatische Veröffentlichung ist nicht mit einzelnen APIs verbunden. Wenn Sie die Einstellung für die automatische Veröffentlichung für eine API aktivieren, gilt sie für alle anderen APIs, unabhängig vom Katalog oder Gateway. Es wird daher dringend empfohlen, einen einzigen Satz von Einstellungen für alle APIs auszuwählen, anstatt die Einstellungen für jede API einzeln zu ändern.
  4. Wählen Sie eine der folgenden Aktionen aus:
    • So veröffentlichen Sie die API, indem Sie sie zu einem neuen Produkt hinzufügen:
      1. Wählen Sie Neues Produkt - Veröffentlichen mit einem neuen Produkt.
      2. Wenn Sie dazu aufgefordert werden, geben Sie einen Titel und eine Versionein.
      3. Der Name des Produkts wird automatisch eingegeben. Der Name wird verwendet, um in CLI-Befehlen auf das Produkt zu verweisen. Siehe die Referenzdokumentation zur CLI des Toolkits.
      4. Klicken Sie auf Weiter.
    • So veröffentlichen Sie die API, indem Sie sie zu einem vorhandenen Produkt hinzufügen:
      1. Wählen Sie Vorhandenes Produkt - Veröffentlichen mit einem vorhandenen Produkt aus.
      2. Wählen Sie das Produkt aus, das Sie verwenden möchten.
      3. Klicken Sie auf Weiter.
  5. Wählen Sie den Katalog aus, in dem Sie das Produkt veröffentlichen möchten.
  6. Wenn Bereiche im ausgewählten Katalog aktiviert wurden, wählen Sie den Bereich aus, den Sie benötigen.
    Hinweis: Die Kataloge, aus denen Sie auswählen können, sind diejenigen, die für den Management-Server und die Providerorganisation definiert sind, mit denen Sie verbunden sind.

    Wenn Sie die API Manager-Benutzeroberfläche verwenden, werden die Verbindungsdetails durch die API URL, die Sie öffnen, und die Benutzer-ID, mit der Sie sich anmelden, bestimmt. Wenn Sie die Benutzeroberfläche des API Designers verwenden, geben Sie die Daten des Verwaltungsservers und die Benutzer-ID in dem Anmeldefenster ein, das beim ersten Start des API Designers angezeigt wird; siehe „Anmeldung beim API Designer “.

    Details zum Erstellen eines Katalogs in einer Providerorganisation finden Sie unter Kataloge erstellen und konfigurieren.

  7. Wenn Sie das Produkt nur für ausgewählte Gateway-Services veröffentlichen möchten, wählen Sie In bestimmten Gateway-Services veröffentlichenund anschließend die erforderlichen Gateway-Services aus. Es werden nur die Gateway-Services aufgelistet, deren Typ der Einstellung für den Gateway-Typ des Produkts entspricht. Informationen zu Gateway-Typen finden Sie unter API Connect „Gateway-Typen “.
  8. Klicken Sie auf Veröffentlichen.

Ergebnisse

Ihr Produkt wird in einem Katalog veröffentlicht. Sie können den Status des Produkts im Katalog in API Manageranzeigen. Wenn Sie das Produkt über API Designerveröffentlicht haben, stellen Sie sicher, dass Sie mit demselben Benutzernamen und Kennwort wie für API Designer bei API Manager angemeldet sind. Klicken Sie in der Benutzeroberfläche des API-Managers auf Symbol 'Verwalten' im Navigationsfenster der API Manager-Benutzerschnittstelle „Verwalten“ und wählen Sie dann den gewünschten Katalog aus. Das Produkt wird mit dem Status Veröffentlicht angezeigt.

Informationen zum Lebenszyklus eines Produkts finden Sie unter Produktlebenszyklus.

Wenn eine Genehmigung zum Veröffentlichen von Produkten im Katalog erforderlich ist, wird eine Anforderung zum Genehmigen der Veröffentlichung gesendet und das Produkt wird in den Wartestatus verschoben. Das Produkt wird im Katalog veröffentlicht, sobald die Anforderung genehmigt wurde. Wenn keine Genehmigung erforderlich ist, wird das Produkt sofort veröffentlicht.

Anmerkung: Wenn eine Genehmigung erforderlich ist, um Produkte im Katalog bereitzustellen, wird eine Genehmigungsanforderung für die Phase gesendet. Wenn die Anforderung genehmigt wird, wird das Produkt in den Status "bereitgestellt" versetzt und muss separat im Katalog veröffentlicht werden. Informationen zum Veröffentlichen eines bereitgestellten Produkts in einem Katalog finden Sie unter Produkt veröffentlichen.

Weitere Informationen zum Konfigurieren von Genehmigungen für den Produktlebenszyklus für einen Katalog finden Sie unter „Kataloge erstellen und konfigurieren “. Weitere Informationen zum Genehmigen von Anfragen finden Sie unter „Genehmigen von Anfragen zum Produktlebenszyklus und zu Abonnements “.

Wenn das Produkt keine Pläne enthält, wird dem Produkt im Katalog automatisch ein Plan namens Standardplan hinzugefügt.