OpenAPI-Darstellung generieren

OpenAPI ist eine standardisierte Version der Swagger Specification. Es bietet eine sprachunabhängige Möglichkeit zur Darstellung von REST-APIs. Sie können OpenAPI-Darstellungen für die Ausführung von Entscheidungsservices generieren. Diese Funktion ist Teil von ODM Decision Connect. ODM Decision Connect ermöglicht Ihnen, wiederverwendbare Entscheidungen als öffentliche APIs zugänglich zu machen, die auf OpenAPI basieren und direkt von Anwendungen aufgerufen werden können. Die OpenAPI-based Entscheidungen können auch in einem IBM API Connect® Katalog für verwaltete APIs veröffentlicht werden. Ein weiterer, optionaler Teil von Decision Connect ist IBM API Connect Essentials.

Informationen zu dieser Task

Wenn Sie eine JSON-Eingabe für die POST-Methode für einen bestimmten Endpunkt-URI eines Regelsatzes schreiben möchten, können Sie die OpenAPI-Darstellung generieren. Die OpenAPI-Darstellung enthält einen Eintrag für die POST-Methode.

Um eine OpenAPI Darstellung zu generieren, können Sie die Endpunkt-URIs verwenden. Weitere Informationen über OpenAPI, finden Sie auf der Seite The OpenAPI Specification Externer Link öffnet ein neues Fenster oder eine neue Registerkarte auf der Website der Open API Initiative.
Hinweis: Die REST-APIs verwenden OpenAPI 3.0. Für weitere Informationen siehe OpenAPI Spezifikation Externer Link öffnet ein neues Fenster oder eine neue Registerkarte.

Prozedur

  1. Definieren Sie die Anforderung:
    https://<vhostname>.bpm.ibmcloud.com/odm/<odm_on_cloud_environment>/DecisionService/rest/v1/{rulesetPath}/openapi?format={format}

    Setzen Sie {format} auf das Format der OpenAPI-Definitionsdatei, d. h. auf den Wert YAML oder JSON. Das Standardformat ist YAML.

    Die URI-Variablen sind in Endpoint URIs definiert.

    Das folgende Beispiel zeigt, wie die Generierung einer OpenAPI-Darstellung im YAML-Format angefordert wird:

    GET https://vhost005.bpm.ibmcloud.com/odm/dev/DecisionService/rest/v1/miniloanruleapp/1.0/miniloanrules/1.0/openapi?format=YAML
  2. Optional: Um die Datei OpenAPI in IBM API Connect zu verwenden, verwenden Sie den Abfrageparameter extension und geben Sie apiconnect an.
    Das folgende Beispiel zeigt eine Anforderung zum Erstellen einer OpenAPI -Darstellung im YAML-Format, die in IBM API Connectverwendet wird:
    GET https://vhost005.bpm.ibmcloud.com/odm/dev/DecisionService/rest/v1/miniloanruleapp/1.0/miniloanrules/1.0/openapi?format=YAML&extension=apiconnect

Ergebnisse

Sie haben eine OpenAPI-Darstellung im YAML- oder JSON-Format generiert.

Wenn Sie eine ungültige URL verwendet haben oder bei der OpenAPI-Generierung ein Fehler aufgetreten ist, wird ein Fehlerstatuscode zurückgegeben.
  • Wenn Sie die Anforderung über einen Browser senden, wird die Fehlernachricht auf einer HTML-Seite angezeigt.
    Hinweis: Der Statuscode lautet200trotz der Fehlernachricht, da sie für die HTML-Seite gilt, nicht für das Anforderungsergebnis.
  • Wenn Sie die Anforderung von einem anderen Client als einem Browser gesendet haben, wird ein Statuscode404 (Not Found)wird zurückgegeben und der Fehler wird in XML beschrieben.
Eine Beschreibung der Fehlermeldungen finden Sie in HTTP.