1.2. API 仕様をインポートするためのさまざまなソース

API 仕様のインポートに関して、3scale の管理者はさまざまなソースを利用することができます。それらの概要を以下の表に示します。ここでは、ファイル名のパス、URL、および stdin から OpenAPI 定義を検出するための使用状況オプションを説明しています。

Expand

説明フォーマットコマンドラインの使用

表1.1 OpenAPI 定義の検出
説明	フォーマット	コマンドラインの使用
ファイル名のパスからの OpenAPI 定義の検出:フォーマットは、ファイル名の拡張子から自動的に検出されます。	json および yaml	`$ 3scale import openapi -d <destination> /path/to/your/spec/file.[json\|yaml\|yml]` Copy to Clipboard Toggle word wrap
URL からの OpenAPI 定義の検出:フォーマットは、URL のパスの拡張子から自動的に検出されます。	json および yaml	`$ 3scale import openapi -d <destination> http[s]://domain/resource/path.[json\|yaml\|yml]` Copy to Clipboard Toggle word wrap
stdin からの OpenAPI 定義の検出:OpenAPI リソースのコマンドラインパラメーターは `-` です。フォーマットはパーサーにより内部的に自動検出されます。	json および yaml	`$ tool_to_read_openapi_from_source \| 3scale import openapi -d <destination> -` Copy to Clipboard Toggle word wrap

ファイル名のパスからの OpenAPI 定義の検出:フォーマットは、ファイル名の拡張子から自動的に検出されます。

json および yaml

3scale import openapi -d <destination> /path/to/your/spec/file.[json|yaml|yml]

$ 3scale import openapi -d <destination> /path/to/your/spec/file.[json|yaml|yml]

Copy to Clipboard

Toggle word wrap

URL からの OpenAPI 定義の検出:フォーマットは、URL のパスの拡張子から自動的に検出されます。

json および yaml

3scale import openapi -d <destination> http[s]://domain/resource/path.[json|yaml|yml]

$ 3scale import openapi -d <destination> http[s]://domain/resource/path.[json|yaml|yml]

Copy to Clipboard

Toggle word wrap

stdin からの OpenAPI 定義の検出:OpenAPI リソースのコマンドラインパラメーターは - です。フォーマットはパーサーにより内部的に自動検出されます。

json および yaml

tool_to_read_openapi_from_source | 3scale import openapi -d <destination> -

$ tool_to_read_openapi_from_source | 3scale import openapi -d <destination> -

Copy to Clipboard

Toggle word wrap