Red Hat Summit5.8. OpenAPI 定義からの 3scale バックエンドのインポート
toolbox import コマンドを使用して OpenAPI 定義をインポートし、3scale バックエンド API を作成できます。コマンドラインオプション --backend は、この機能を有効にします。3scale は OpenAPI 定義を使用して、バックエンドとそのプライベートベース URL と、そのマッピングルールおよびメソッドを作成し、保存します。
前提条件
- オンプレミス型 3scale 2.13 インスタンスの管理者権限を持つユーザーアカウント
- API を定義する OAS ドキュメント
手順
以下の形式を使用し、
importコマンドを実行してバックエンドを作成します。$ 3scale import openapi -d <remote> --backend <OAS>
-
<remote>は、バックエンドを作成する 3scale インスタンスの URL に置き換えます。http[s]://<authentication>@3scale_domainの形式を使用します。 <OAS>は/path/to/your/oasdoc.yamlに置き換えます。表5.1 追加の OpenAPI 定義オプション オプション 説明 -o --output=<value>出力フォーマット。JSON または YAML のいずれかを使用できます。
--override-private-base-url=<value>3scale は OpenAPI 定義の
servers[0].urlフィールドからバックエンドのプライベートエンドポイントを読み取ります。このフィールドの設定をオーバーライドするには、このオプションを指定し、<value>は選択したプライベートベース URL に置き換えます。OpenAPI 定義がservers[0].urlフィールドに値を指定しておらず、importコマンドでこのオプションを指定しないと、実行に失敗します。--prefix-matchingOpenAPI 操作から派生するマッピングルールに厳密なマッチングではなく、接頭辞のマッチングを使用します。
--skip-openapi-validationOpenAPI スキーマ検証を省略します。
-t --target_system_name=<value>ターゲットシステム名はテナントの一意のキーです。システム名は OpenAPI 定義から推測できますが、このパラメーターを使用して独自の名前に上書きできます。
