Swagger
Swagger コネクタは、基本、OAuth、およびアプリケーションキーの認証タイプを持つ swagger ファイルをサポートします。このコネクタは、
OpenAPI 2.0 および
OpenAPI 3.0 仕様をサポートしています。
コネクタのリリースバージョン
Swagger コネクタは 8.4.3 リリースで提供されました。
サポートされている操作
サポートされているトリガー
None
サポートされている承認
Swagger コネクタは以下の承認をサポートしています。
• 「なし」
• 「基本」
• 「OAuth」
• 「アプリケーションキー」
Swagger の承認
Swagger コネクタ操作ごとに Swagger の承認を行わなければなりません。認証スキームリストから、次のいずれかの承認スキームを選択します。
• 「なし」 - https://petstore.swagger.io/v2/swagger.json などの Swagger ファイルの URL を指定します。
• 「基本」 - 基本接続を追加するには、次の手順に従います。
1. 認証スキームリストから、「基本」を選択します。
2. 「Swagger Connection」フィールドで、「新規追加」をクリックします。
3. 「接続を追加」ウィンドウで、次の詳細を入力します。
▪ 「接続ラベル」 - 自動的に入力されます。任意の接続ラベルを入力できます。
 |
ラベルでは大文字と小文字が区別されます。空白、一部の特殊文字、先頭の数字は使用しないでください。
|
▪ 「Swagger URL」 - Swagger.json ファイルの URL。
▪ 「ユーザー名」 - ターゲットアプリケーションのユーザー名。
▪ 「パスワード」 - ターゲットアプリケーションのパスワード。
4. 「追加」をクリックします。新しい承認がリストに追加されます。
• 「OAuth」 - OAuth 接続を追加するには、次の操作を実行します。
必要条件 - 新規 OAuth 接続を追加する前に、
コネクタの OAuth の設定のトピックの「Swagger」セクションに記載されているステップに従います。
1. 認証スキームリストから、「OAuth」を選択します。
2. 「Swagger OAuth」フィールドで、「Add new Swagger login」をクリックします。
3. 「パラメータ」ウィンドウで、「Swagger URL」を入力し、「許可」をクリックします。「承認を追加」ウィンドウが開きます。
4. 「承認を追加」ウィンドウで、必要に応じて「承認ラベル」を編集し、リソース URL を入力します。
5. 「追加」をクリックします。
• 「App Key」 - 新規アプリケーションキー接続を追加するには、次の手順に従います。
1. 認証スキームリストから、「App Key」を選択します。
2. 「Swagger AppKey」フィールドで、「新規追加」をクリックします。
3. 「接続を追加」ウィンドウで、次の詳細を入力します。
▪ 「接続ラベル」 - 自動的に入力されます。任意の接続ラベルを入力できます。
|
|
ラベルでは大文字と小文字が区別されます。空白、一部の特殊文字、先頭の数字は使用しないでください。
|
▪ 「Swagger URL」 - https://petstore.swagger.io/v2/swagger.json などの Swagger.json ファイルの URL
▪ 「App Key」 - Swagger アプリケーションキーを入力します。
4. 「追加」をクリックします。
|
|
「テスト」をクリックしてこの承認を検証します。
|
Swagger コネクタの制限事項
• OpenAPI 3.0 の仕様では、サーバーフィールドに複数のベース URL を定義するオプションがあります。現在の実装ではこのオプションはサポートされていませんが、最初のベース URL はサーバー配列から取得されます。
• リクエストでは、application/json および application/x-www-form-urlencoded のメディアタイプを使用できます。ワイルドカードは使用できません。応答の場合、application/json が許可されます。
• ファイルまたはイメージのアップロードとダウンロードはサポートされていません。
• マルチパートまたはフォームデータはサポートされていません。
• パラメータのシリアル化メソッドは、すべてのパラメータに対してデフォルトになります。
• タイプフィールドでは、"one of"、"anyOf"、"allOf"、および "not" の使用はサポートされていません。
• 複数の認証は許可されません。すべての API は同様の認証を持つ必要があります。