5.7. OpenAPI 定義からの 3scale バックエンドのインポート

前提条件

• オンプレミス型 3scale 2.12 インスタンスの管理者権限を持つユーザーアカウント
• API を定義する OAS ドキュメント

手順

• 以下の形式を使用し、import コマンドを実行してバックエンドを作成します。

  $ 3scale import openapi -d <remote> --backend <OAS>

  Copy to Clipboard Toggle word wrap
• <remote> は、バックエンドを作成する 3scale インスタンスの URL に置き換えます。http[s]://<authentication>@3scale_domain の形式を使用します。

• <OAS> は /path/to/your/oasdoc.yaml に置き換えます。

  Expand

  表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-matching	OpenAPI 操作から派生するマッピングルールに厳密なマッチングではなく、接頭辞のマッチングを使用します。
  --skip-openapi-validation	OpenAPI スキーマ検証を省略します。
  -t --target_system_name=<value>	ターゲットシステム名はテナントの一意のキーです。システム名は OpenAPI 定義から推測できますが、このパラメーターを使用して独自の名前に上書きできます。

  Show more