OpenAPI 表現の生成

OpenAPI は、Swagger 仕様の標準化されたバージョンです。これは、REST API を提示するための、言語に依存しない方法を提供します。意思決定サービスを実行するための OpenAPI 表現を生成できます。この機能は、ODM Decision Connect の一部であり、アプリケーションによって直接呼び出され、OpenAPI ベースの API として公開される再使用可能意思決定を有効にします。 OpenAPI ベースの意思決定はまた、管理対象 API の IBM API Connect カタログにパブリッシュすることもできます。 IBM API Connect Essentials もまた、Decision Connect のオプションの部分です。

このタスクについて

特定のルール・セット・エンドポイント URI への POST メソッドの JSON 入力を作成するために、OpenAPI 表現を生成できます。 OpenAPI 表現には、POST メソッドの 1 つのエントリーが含まれています。

OpenAPI 表現を生成するには、エンドポイント URIを使用できます。 OpenAPI, の詳細については、Open API Initiativeウェブサイトの OpenAPI ページをご覧ください。

注: REST API は OpenAPI 3.0を使用します。詳しくは、 OpenAPI 仕様を参照してください。

手順

要求を定義します。
```
https://<vhostname>.bpm.ibmcloud.com/odm/<odm_on_cloud_environment>/DecisionService/rest/v1/{rulesetPath}/openapi?format={format}
```
{format} に OpenAPI 定義ファイルのフォーマットを、YAML か JSON のどちらかで指定します。デフォルトのフォーマットは YAML です。

URI 変数は、エンドポイント URIで定義されます。
次の例は、YAML フォーマットで OpenAPI 表現を生成する要求を示しています。
```
GET https://vhost005.bpm.ibmcloud.com/odm/dev/DecisionService/rest/v1/miniloanruleapp/1.0/miniloanrules/1.0/openapi?format=YAML
```
オプション: IBM API Connect®で OpenAPI ファイルを使用するには、 extension 照会パラメーターを使用して apiconnectを指定します。
以下の例は、YAML 形式の OpenAPI 表現を生成し、それを 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
```

結果

YAML フォーマットまたは JSON フォーマットの OpenAPI 表現を生成しました。

無効な URL を使用した場合や OpenAPI の生成中にエラーが発生した場合は、エラー状況コードが返されます。

ブラウザーから要求を送信した場合は、HTML ページにエラー・メッセージが表示されます。
注: 状況コードは次のとおりです。200要求結果ではなく、HTML ページに適用されるため、エラー・メッセージが表示されます。
ブラウザー以外のクライアントから要求を送信した場合は、状況コード。404 (Not Found)戻され、エラーは XML で記述されます。

HTTPのエラーメッセージの説明は、こちらをご覧ください。