Bereitstellen einer API

Online bearbeiten

Der grafische Assistent bietet eine Option, mit der die API zu einem Produkt hinzugefügt und das Produkt in einem Katalog bereitgestellt wird. Wenn sich ein Produkt im bereitgestellten Status befindet, ist es noch nicht für alle Entwickler sichtbar bzw. von allen Entwicklern abonnierbar. Die Syndikationsfunktion in IBM® API Connect bedeutet, dass Produkte nur in einem Bereich in diesem Katalog bereitgestellt werden können, wenn Bereiche für einen Katalog aktiviert sind.

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 Abschnitt beschriebenen Produktmanagementtasks ausführen zu können, müssen Sie entweder der Eigner der API-Provider-Organisation sein oder über die Berechtigung Produkt > Bereitstellen für den Zielkatalog oder Bereichverfü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 Bereitstellung ist nicht verfügbar, wenn Sie im API Designer offline arbeiten.

Ein Katalog ist ein Staging-Ziel und fungiert als logische Unterteilung des „ DataPower® Gateway “ und des „Consumer Catalog “.

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: 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

Klicken Sie im Navigationsbereich auf „Entwickeln “ und wählen Sie dann die Registerkarte „APIs“ aus.
Die Seite Entwickeln wird angezeigt.
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.
Sie können eine API über die Listenseite Entwickeln oder über die API-Definition selbst bereitstellen.
1. Um eine API über die Seite „Develop“ bereitzustellen, klicken Sie auf das Symbol für das Optionsmenü neben der gewünschten API und wählen Sie dann „Bereitstellen“ aus.
2. Führen Sie die folgenden Schritte durch, um eine API aus der API-Definition heraus bereitzustellen:
  1. Klicken Sie auf den Titel der API, mit der Sie arbeiten möchten.
  2. Klicken Sie auf das Symbol für das Optionsmenü:
  3. Klicken Sie auf Stage.
Wählen Sie eine der folgenden Aktionen aus:
- So stellen Sie die API bereit, 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 Befehlszeilenschnittstelle des Toolkits.
  4. Klicken Sie auf Weiter.
- So stellen Sie die API bereit, 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.
Wählen Sie auf der Seite Bereitstellen in den Katalog aus, in dem Sie das Produkt bereitstellen möchten.

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.
Wenn das bereitgestellte Produkt zu einem späteren Zeitpunkt veröffentlicht werden soll, soll es nur für ausgewählte Gateway-Services veröffentlicht werden. 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 “.
Klicken Sie auf Stage.

Ergebnisse

Ihr Produkt wird in einem Katalog bereitgestellt. Sie können den Status des Produkts im Katalog in API Manageranzeigen. Wenn Sie das Produkt über API Designerbereitgestellt haben, stellen Sie sicher, dass Sie bei API Manager mit demselben Benutzernamen und Kennwort angemeldet sind, die Sie für API Designer verwendet haben. 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 Bereitgestellt angezeigt.

Informationen zum Lebenszyklus eines Produkts finden Sie unter Produktlebenszyklus.

Wenn eine Genehmigung zum Bereitstellen von Produkten im Katalog erforderlich ist, wird eine Genehmigungsanforderung gesendet und das Produkt in den Wartestatus verschoben. Das Produkt wird bereitgestellt, sobald die Anforderung genehmigt wurde. Wenn keine Genehmigung erforderlich ist, wird das Produkt sofort bereitgestellt.

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.