9.3. OpenAPI Specification の機能
注記
ActiveDocs は、OpenAPI (OAS) のインポート時に作成、更新されます。
-
サービスの
system_name
をオプションのパラメーターとして渡すことができ、そのデフォルトは OAS からの info.title フィールドです。 メソッドは OAS からの各操作に対して作成されます。
-
メソッド 名は
operation.operationId
フィールドから取得されます。
-
メソッド 名は
既存の マッピングルール は、新規 API 定義をインポートする前にすべて削除されます。
- コマンドの実行前から存在するメソッドは削除されません。
- マッピングルールは、OAS からの各操作に対して作成されます。
OpenAPI 定義リソースは、以下のチャンネルのいずれかで提供することができます。
- 利用可能なパスの ファイル名
- URL フォーマット (toolbox は所定のアドレスからダウンロードを試みます)
- stdin 標準入力ストリームから読み込む