Erstellen einer SOAP-Proxy-API aus einem vorhandenen WSDL-Service

Online bearbeiten

Wenn ein SOAP-Service in einer WSDL -Datei definiert ist, können Sie die WSDL -Datei verwenden, um eine API Connect -SOAP-Proxy-API zu erstellen, die diesen SOAP-Service aufruft.

Informationen zu dieser Task

Draft comment: gb042610
Marking all content that relates to importing from a URL as Future, as this option has been deferred: https://github.ibm.com/velox/ui/issues/5878 JenD Mar2018

Sie können diese Task entweder mithilfe der UI-Anwendung API Designer oder mithilfe der browserbasierten Benutzerschnittstelle von API Manager ausführen.

Um diese Task auszuführen, muss Ihnen eine Rolle zugeordnet sein, die über die Berechtigungen Api-Drafts:Edit, Settings:View und App:View verfügt. Die vorab bereitgestellte Entwicklerrolle weist diese Berechtigungen standardmäßig auf; wenn Ihnen eine angepasste Rolle zugeordnet wird, muss sie über diese Berechtigungen verfügen. Weitere Informationen finden Sie unter Angepasste Rollen erstellen.

Hinweis: Standardmäßig ist für die erstellte SOAP-Proxy-API der Basispfad auf den WSDL-Servicenamen gesetzt. Sie können die SOAP-Proxy-API bearbeiten, um diesen Basispfad zu ändern.
Sie können eine SOAP-API hinzufügen, um einen vorhandenen SOAP-Service zugänglich zu machen, indem Sie die WSDL -Datei bereitstellen, die diesen vorhandenen Service auf eine der folgenden Arten definiert:
  • Wenn die WSDL -Datei eine eigenständige Datei ohne externe Abhängigkeiten ist, können Sie die Datei .wsdl aus einem Verzeichnis laden, um die SOAP-API-Definition zu erstellen.
  • Sie können eine oder mehrere WSDL -Dateien in einer einzigen .zip -Datei bereitstellen, die die WSDL -Dateien und alle erforderlichen Schemas enthält.

    Wenn die WSDL -Datei auf andere WSDL -Dateien oder auf XSD-Dateien mit XML-Schemadefinitionen verweist, müssen Sie ein .zip -Archiv der WSDL -Datei und der zugehörigen abhängigen Dokumente erstellen und anschließend die Datei .zip aus einem Verzeichnis laden, um die SOAP-API-Definition hinzuzufügen.

  • Wenn Sie API Designer mit vorhandenen APIs verwenden, die aus einer WSDL-oder WSDL.zip -Datei in API Designer der Version 5 erstellt wurden, stellen Sie sicher, dass die folgenden Voraussetzungen erfüllt sind:
    • Die WSDL-oder WSDL.zip -Datei muss in demselben Verzeichnis wie die YAML-Datei der API gespeichert werden.
    • In der YAML-Datei der API muss die Eigenschaft x-ibm-configuration -- > wsdl-definition -- > wsdl direkt auf die WSDL-oder WSDL.zip -Datei ohne Pfad verweisen (die Dateien befinden sich im selben Verzeichnis).

Der Service muss Web Services Basic Profile Version 1.1 - Second Edition unterstützen.

Draft comment: gb042610
Import from URL has been deferred: https://github.ibm.com/velox/ui/issues/5878 JenD Mar2018

Vorgehensweise

Gehen Sie wie folgt vor, um eine SOAP-API-Definition durch Laden einer WSDL -Datei hinzuzufügen:
  1. Klicken Sie im Navigationsbereich Symbol für Entwicklung im Navigationsfenster der API-Benutzerschnittstelle Entwickeln, dann auf Hinzufügen > API klicken.
    Die Anzeige API-Typ auswählen wird angezeigt.
  2. Wählen Sie „ OpenAPI “ unter 2.0.
  3. Wählen Sie Aus vorhandenem WSDL-Service (SOAP-Proxy)aus. Klicken Sie auf Weiter.
    Das Fenster API aus vorhandenem WSDL-Service erstellen (SOAP-Proxy) wird geöffnet.
  4. Um die Serviceinformationen aus einer eigenständigen .wsdl Datei oder einer .zip Datei hochzuladen, die eine WSDL -Datei und die dazugehörigen Dokumente enthält, können Sie die Datei entweder per Drag & Drop ziehen oder sie über die Dateiauswahl auswählen.
    Draft comment: gb042610
    There is no option to load from URL yet... so marking these choices as future. JenD Mar2018

    Nachdem Sie die Datei hochgeladen haben, wird die WSDL ausgewertet und eine Nachricht zeigt an, ob die WSDL gültig ist.

    Wenn Sie eine .zip-Datei hochladen, können Sie in die .zip-Datei eine Optionsdatei einfügen, um zusätzliche Anweisungen anzugeben. Weitere Informationen finden Sie unter „Verwenden einer Optionsdatei beim Importieren eines WSDL-Dienstes “.

  5. Klicken Sie auf Weiter. Wählen Sie im Fenster "Service auswählen" einen WSDL-Service aus der importierten Datei aus.
  6. Klicken Sie auf Weiter. Geben Sie die API-Zusammenfassung im Abschnitt Info an. Sie können die API nach dem Erstellen optimieren.
    • Der Titel kann Sonderzeichen enthalten, sollte aber kurz gehalten werden, sodass er leicht in der Benutzerschnittstelle angezeigt werden kann.
    • Der Name wird automatisch eingegeben. Der Wert im Feld Name ist eine einzelne Zeichenfolge, die zum Identifizieren der API in Entwicklertoolkit -CLI-Befehlen verwendet wird. Die CLI-Befehle zur Verwaltung von API-Entwürfen finden Sie in der Referenzdokumentation zur Toolkit-CLI.
    • Die Version entspricht dem Wert der Eigenschaft info.version der API-Definition OpenAPI . Das Versionsnummerierungsschema version.release.modification wird empfohlen, z. B. 1.0.0.
    • Der Basispfad ist das URL-Segment der API und schließt weder den Hostnamen noch weitere Segmente für Pfade oder Operationen ein. Der Basispfad darf keine Sonderzeichen enthalten und muss mit dem Zeichen / beginnen, auch wenn er ansonsten leer ist.
    • Mit der optionalen Beschreibung können Sie die API identifizieren.
  7. Klicken Sie auf Weiter. Konfigurieren Sie im Abschnitt Sichern die API-Sicherheit, die Sie benötigen.
    • Mit Client-ID sichern - Wählen Sie diese Option aus, um erforderlich zu machen, dass eine Anwendung eine Client-ID (API-Schlüssel) bereitstellt. Dadurch wird der Parameter X-IBM-Client-Id in den Anforderungsheader für die API eingeschlossen. Wird er ausgewählt, können Sie dann auswählen, ob die API-Aufrufe auf Schlüsselbasis (pro Client-ID) begrenzt werden sollen:
      • API-Aufrufe auf Schlüsselbasis begrenzen - Ist diese Option ausgewählt, müssen Sie die erforderliche Ratenbegrenzung konfigurieren. Ratenbegrenzungen steuern die maximal zulässige Anzahl an Aufrufen innerhalb eines bestimmten Zeitraums (Stunde, Minute, Monat oder Tag). Beispiel: 100 Aufrufe pro Stunde.
    • CORS - Wählen Sie diese Option aus, um CORS-Unterstützung (CORS - Cross-Origin Resource Sharing) für Ihre API zu aktivieren. Auf diese Weise kann die API von einer anderen Domäne aus aufgerufen werden.
      Hinweis:
      • CORS Support ist nur auf der DataPower® API Gateway. verfügbar.
      • Wenn CORS aktiviert ist, führt das API-Gateway die cors -Preflow-Richtlinie aus, um alle CORS-Anforderungen zu verarbeiten, die an die API gesendet werden.
      • Wenn CORS aktiviert ist und eine Preflight-Anforderung empfangen wird, werden nur die folgenden API-Aktionen ausgeführt:
        • Die Preflow-Richtlinie cors konfiguriert die entsprechenden Antwortheader.
        • Die Antwortheader werden festgelegt.
      • Wenn eine Preflight-Anforderung empfangen wird, wird das request.attributes.isCORSPreflight -Flag auf truegesetzt.
      • Bei allen Preflight-Anforderungen werden die Preflow-Richtlinien von security und client-identification immer übersprungen, unabhängig davon, ob CORS aktiviert oder nicht aktiviert ist.
  8. Optional: Wählen Sie „API aktivieren“, wenn Sie die API sofort für die weitere Entwicklung und für Tests nutzen möchten.
    Hinweis:
    • Wenn Sie die Option API aktivieren auswählen, führt API Connect automatisch die folgenden Aktionen aus:
      • Erstellt einen Entwurfsprodukt, fügt die API zum Produkt hinzu und veröffentlicht das Produkt im Sandbox-Katalog, sodass die API aufgerufen werden kann. Das Produkt hat den Titel api_title auto product. Dieses Produkt ist in der Ansicht Entwickeln nicht sichtbar und kann nicht direkt gelöscht werden. Wenn Sie die API jedoch löschen, wird der Produktentwurf zusammen mit der API gelöscht; siehe „Eine API-Definition löschen “. Das Produkt ist in allen Katalogen sichtbar, für die es veröffentlicht wurde. Wenn Sie das Produkt aus einem Katalog entfernen möchten, müssen Sie dies separat vornehmen; siehe „Ein Produkt aus einem Katalog entfernen“
      • Abonniert die Sandbox-Testanwendung für das Produkt, sodass Sie die API sofort in der Testumgebung testen können. Informationen zum Testen einer API finden Sie unter Testen einer API.
    • Sie können die Option „Activate API“ nicht verwenden, wenn im Sandbox-Katalog für die Aktionen „Stage“, „Publish“ oder „Replace“ die Lebenszyklusgenehmigung aktiviert ist. Wenn solche Lebenszyklus-Genehmigungen aktiviert sind, müssen sie deaktiviert werden, damit die Option „Activate API“ genutzt werden kann; Informationen zu den Einstellungen für Lebenszyklus-Genehmigungen finden Sie unter „Kataloge erstellen und konfigurieren “.
    • Um die Option API aktivieren verwenden zu können, muss Ihnen eine Rolle mit den Berechtigungen Product:Manage und Subscription:Manage zugewiesen sein. Die vorab bereitgestellte Entwicklerrolle weist diese Berechtigungen standardmäßig auf; wenn Ihnen eine angepasste Rolle zugeordnet wird, muss sie über diese Berechtigungen verfügen. Weitere Informationen finden Sie unter Angepasste Rollen erstellen.
  9. Klicken Sie auf Weiter , um Ihre API-Definition zu erstellen.

    In der Zusammenfassungsanzeige werden Nachrichten angezeigt, während die Definition erstellt wird, und die ausgewählten Sicherheitsoptionen und Ratenbegrenzungen werden erzwungen.

    Wenn Sie API aktivieren ausgewählt haben, gibt der Assistent eine URL an, die Sie beim Testen verwenden können. Wenn Sie auch Mit Client-ID sichern ausgewählt haben, zeigt der Assistent eine Client-ID und einen geheimen Clientschlüssel an, die Sie verwenden können.

  10. Wählen Sie eine der folgenden Optionen aus:
    • Um die API weiter zu konfigurieren, klicken Sie auf API bearbeiten. Details finden Sie unter Bearbeiten einer API-Definition.
    • Wenn Sie Ihre API zu diesem Zeitpunkt nicht weiter konfigurieren möchten, klicken Sie auf den Link Entwickeln im Navigationspfad, um zur Begrüßungsseite zurückzukehren. Sie können anschließend sofort mit einer anderen Task fortfahren. Details zur späteren Konfiguration Ihrer API finden Sie unter Bearbeiten einer API-Definition.

Ergebnisse

Sie haben eine SOAP-API-Definition mithilfe einer vorhandenen WSDL-Datei erstellt.

Nächste Schritte

APIs werden für Anwendungsentwickler verfügbar gemacht, indem Sie sie in ein Produkt einschließen und dieses Produkt anschließend in einem Katalog veröffentlichen. Weitere Informationen finden Sie unter „Arbeiten mit Produkten “ und „Arbeiten mit Katalogen “.

Sie können den Produktlebenszyklus verwalten und festlegen, wer Ihr Produkt sehen und abonnieren darf, indem Sie den mit Ihrer API verknüpften Sandbox-Katalog auf der Seite Symbol 'Verwalten' im Navigationsfenster der API Designer-Benutzerschnittstelle „Verwalten“ der API-Designer -Benutzeroberfläche öffnen.