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, mit dem wiederverwendbare Entscheidungen als OpenAPI-basierte öffentliche APIs zugänglich gemacht werden können, die von Anwendungen direkt aufgerufen werden können. Die OpenAPI-based Entscheidungen können auch in einem IBMAPI 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 finden Sie OpenAPI,Die OpenAPI Spezifikation Externer Link öffnet ein neues Fenster oder einen neuen Tab

auf der Seite der Open API Initiative-Website.

Hinweis: Die REST-APIs verwenden OpenAPI 3.0. Weitere Informationen finden Sie unter OpenAPI Spezifikation Externer Link öffnet ein neues Fenster oder einen neuen Tab

Vorgehensweise

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 Endpunkt-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
```
Optional: Um die OpenAPI Datei in zu verwenden IBMAPI Connect, verwenden Sie den extension Abfrageparameter und geben Sie apiconnect an.
Das folgende Beispiel zeigt eine Anfrage zur Generierung einer OpenAPI Darstellung im YAML-Format und deren Verwendung in IBM API Connect :
```
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 Fehlermeldung, da diese sich auf die HTML-Seite bezieht, nicht auf das Ergebnis der Anfrage.
Wenn Sie die Anfrage 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 unter HTTP Statuscodes.