Bereitstellen eines Produktentwurfs

Online bearbeiten

Fügen Sie einen Produktentwurf in einen Katalog ein, um vor der Veröffentlichung eine bestimmte Version dieses Produkts zu erstellen. Wenn sich ein Produkt im Status 'Bereitgestellt' befindet, ist es für Entwickler noch nicht sichtbar oder kann von diesen abonniert werden. 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.
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 Staging-Funktion 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 “.

Sie stellen ein Produkt bereit, damit die entsprechenden Genehmigungen innerhalb des Unternehmens erteilt werden können und das Produkt veröffentlicht werden kann. 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 “. Weitere Informationen zum Veröffentlichen eines Produkts finden Sie unter „Ein Produkt veröffentlichen “.

Sie können eine vorhandene Produktversion nicht erneut in einen Produktionskatalog aufnehmen. Wenn Sie eine API aktualisieren, müssen Sie eine neue Version dieser API erstellen. Erstellen Sie anschließend eine neue Version des Produkts, sodass es die neuere Version der API enthält. Weitere Informationen zum Erstellen neuer Versionen von APIs und Produkten finden Sie unter „Eine neue Version einer API-Definition erstellen “ und „Eine neue Version Ihres Produkts erstellen “. Wenn „Spaces“ in einem Produktionskatalog aktiviert sind, können Sie dieselbe API- oder Produktversion nicht erneut in einem beliebigen Space des Katalogs bereitstellen. Sie können eine Produktversion jedoch in den Sandbox-Katalog oder einen anderen Nicht-Produktionskatalog übertragen, um iterative Tests zu vereinfachen.
Hinweis: Wenn Sie eine Produktversion in einen Nicht-Produktionskatalog verschieben, werden die bestehenden Anwendungsabonnements gelöscht. Die Abonnements werden gelöscht, um die skriptgesteuerte Bereitstellung in einer Continuous-Integration-Umgebung zu erleichtern, in der die Neuerstellung von Anwendungsabonnements durch Skripte gesteuert wird.
Wenn Spaces in einem Nicht-Produktionskatalog aktiviert sind und Sie eine Produktversion in einen anderen Space als den zuvor verwendeten übertragen, wird sie aus dem vorherigen Space entfernt und in den neu angegebenen Space übertragen. Wenn die Abrechnungsintegration in einem Produkt aktiviert ist, können Sie dieselbe Produktversion nicht erneut in einem Nicht-Produktions- oder Produktionskatalog bereitstellen. Weitere Informationen zur Abrechnungsintegration finden Sie unter Produkte monetarisieren.
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

Führen Sie die folgenden Schritte durch, um ein Produkt bereitzustellen:
  1. 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.
  2. Klicken Sie im Navigationsbereich auf Symbol 'Entwickeln' im Navigationsfenster „Entwickeln “.
  3. Wählen Sie die Registerkarte Produkte aus
  4. Sie können ein Produkt über die Listenseite Entwickeln oder über das Produkt selbst bereitstellen.
    1. Um ein Produkt über die Entwicklungs -Übersichtsseite bereitzustellen, klicken Sie auf das Optionsmenü-Symbol Symbol für Optionen neben der gewünschten Produktversion und wählen Sie dann „Bereitstellen“ aus.
    2. Führen Sie die folgenden Schritte aus, um ein Produkt aus dem Produkt selbst bereitzustellen:
      1. Klicken Sie auf die Produktversion, mit dem Sie arbeiten möchten.
      2. Klicken Sie auf das Symbol für das Optionsmenü:
        Screenshot mit Hervorhebung des Optionsmenüsymbols
      3. Wählen Sie Stageaus.
  5. Wählen Sie den Katalog aus, in dem Sie das Produkt bereitstellen 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 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 “.
  8. Klicken Sie auf Weiter.

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 API-Manager-Benutzeroberfläche 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.

Nächste Schritte

  • Veröffentlichen Sie Ihr Produkt, damit Anwendungsentwickler im Verbraucherkatalog darauf zugreifen können. Weitere Informationen finden Sie unter „Ein Produkt veröffentlichen “.