API-Definition erstellen

Online bearbeiten

Sie können API-Definitionen mithilfe des API-Designers oder der Befehlszeilenschnittstelle unter IBM® erstellen API Connect.

Vorbereitende Schritte

Eine API ist ein Satz von Funktionen, die eine gewisse Geschäfts- und technische Funktionalität bereitstellen und mithilfe eines definierten Protokolls von Anwendungen aufgerufen werden können. Bei Anwendungen handelt es sich im Allgemeinen um mobile Anwendungen oder Webanwendungen, die das HTTP-Protokoll verwenden. Eine API-Definition besteht aus Pfaden und kann einen der folgenden Typen aufweisen:

REST-API-Definition

Eine REST-API ist ein definierter Satz von Interaktionen, der das HTTP-Protokoll verwendet, normalerweise durch Verwendung von JSON oder XML als Datenformat, das ausgetauscht wird. Beispielsweise könnte eine Datenanforderung eine HTTP GET-Methode und ein Datensatz eine HTTP POST-Methode verwenden. Die Wahl des Datenformats hängt vom Typ der Anwendung ab, die die API aufruft. JSON wird häufig für Webseiten oder mobile Anwendungen verwendet, die eine Benutzeroberfläche bereitstellen (mithilfe von JavaScript™ oder HTML), während XML oft für Maschine-zu-Maschine-Szenarien eingesetzt wird.

Sie können Ihre bestehenden APIs mithilfe einer Proxy- oder Invoke -Richtlinie verfügbar machen und sichern.

In beiden Fällen können Sie Ihre API-Definition entweder mit API Designerkonfigurieren oder indem Sie eine OpenAPI -Definitionsdatei schreiben und sie entweder mit API Designer oder über die Befehlszeilenschnittstelle veröffentlichen.

SOAP-API

Sie können SOAP-API-Definitionen erstellen, die auf einer bestehenden WSDL-Datei (WSDL - Web Services Description Language) basieren. Sie können diese Funktion verwenden, damit Sie von den Möglichkeiten von profitieren können, einschließlich Analyse und der Zuordnung zwischen Variablen. Sie können die API auch über den Consumer Catalog für alle vorhandenen SOAP-Dienste in Ihrem Unternehmen verfügbar machen, einschließlich aller SOAP-Dienste, die Teil einer serviceorientierten Architektur (SOA) oder einer Enterprise Service Bus (ESB)-Infrastruktur sind.

Sie können SOAP-API-Definitionen über die Befehlszeilenschnittstelle oder über API Designererstellen.

Informationen zu dieser Task

Sie können Definitionen für REST-APIs oder SOAP-APIs erstellen.

  • In API Designerkönnen Sie eine REST API-Definition hinzufügen, indem Sie entweder die API-Definition und ihre Operationen völlig neu erstellen oder eine OpenAPI -Definitionsdatei importieren. Sie können die Tools auch verwenden, um schnell eine proxy-API zu erstellen, die einen vorhandenen Endpunkt aufruft.
  • Wenn Sie bereits über einen SOAP-Dienst verfügen, den Sie einem breiteren Publikum zugänglich machen möchten, können Sie eine SOAP-API unter IBM® API Connect hinzufügen. Sie können den Consumer-Katalog nutzen, um den SOAP-Dienst den Entwicklern bekannt zu machen. Wenn ein Entwickler die SOAP-API verwenden möchte, können Sie mithilfe von dessen Registrierung und den Zugriff auf den Service verwalten und die Nutzung dieser API verfolgen.

Vorgehensweise

  1. Verwenden Sie einen der folgenden Assistenten, um schnell eine API-Definition zu erstellen:
  2. Nachdem Sie Ihre API-Definition erstellt haben, können Sie diese anhand der Anweisungen unter „Bearbeiten einer API-Definition“ ( OpenAPI2.0 ) genauer festlegen.