Search

接続

接続

前へ次へ

Swaggerファイルの生成

Swaggerファイルの生成

REST V2接続用のswaggerファイルは、

管理者

の

［Swaggerファイル］

ページから生成できます。

［新規］

をクリックします。

swaggerファイルの名前と説明を入力します。

swaggerの詳細を指定します。次の表は、swaggerファイルを作成する際のパラメータを示しています。

パラメータ	説明
ランタイム環境	必須。swaggerファイルの生成に使用されるランタイム環境の名前。
URL	必須。URLは、ホスト名とポート番号から構成されます。以下に例を示します。 http://localhost:8000
動詞	Webサービスで使用されているRESTメソッドを選択します。サポートされているメソッドは、GET、POST、PUT、およびDELETEです。
認証タイプ	必要な場合、Webサービスアプリケーションにログインする際の認証方式を選択します。デフォルトは［なし］です。
APIの基本パス	APIが動作するパス。基本パスはホスト名とポートの後に指定します。例えば、REST WebサービスURLが http://localhost:8000/greetings/hello?Status=GoodMorning の場合、基本パスは /greetings になります。
APIのパス	基本パスの後に指定するパスが、APIのパスです。例えば、REST WebサービスURLが http://localhost:8000/greetings/hello?Status=GoodMorning の場合、APIパスは /hello?Status=GoodMorning になります。パスパラメータを定義するには、変数として処理されるように中括弧{}でパスを囲みます。例えば、REST WebサービスURLが https://localhost:8080/sample/Stringoperation/concat/str1/str2?id=123 で、concatがこのパスの変数の場合、APIパスは次のように定義します。 Stringoperation/{ concat } /str1/str2?id=123 パスパラメータの数を定義できます。［APIのパス］には、クエリパラメータを指定できます。［APIのパス］でクエリパラメータを定義する場合は、［クエリパラメータ］フィールドでクエリパラメータを指定しないでください。
ユーザー名	Webサービスアプリケーションにログインするユーザーの名前。認証タイプが［基本］および［ダイジェスト］の場合に必要です。
パスワード	ユーザー名に関連付けられるパスワード。認証タイプが［基本］および［ダイジェスト］の場合に必要です。
トークン	Webサービスアプリケーションに接続するためのアクセストークン。認証タイプが［OAuth］の場合にのみ必要です。
トークンシークレット	OAuthトークンに関連付けられるパスワード。認証タイプが［OAuth］の場合に必要です。
コンシューマキー	Webサービスアプリケーションに関連付けられるクライアントキー。認証タイプが［OAuth］の場合に必要です。
コンシューマシークレット	Webサービスアプリケーションに接続するためのクライアントパスワード。認証タイプが［OAuth］の場合にのみ必要です。
承認	MIMEタイプを選択します。
ヘッダー	JSON形式のヘッダーパラメータを定義します。例えば、{"Accept-Charset":"utf-8"}のように指定します。
クエリパラメータ	JSON形式のクエリパラメータを指定します。例えば、{"name":"subject","description":"The subject to be greeted."}のように指定します。［クエリパラメータ］フィールドでクエリパラメータを定義すると、Swagger仕様ファイルの入力パラメータとしてクエリパラメータが追加されます。［クエリパラメータ］でクエリパラメータを定義する場合は、［APIのパス］フィールドでクエリパラメータを指定しないでください。
操作ID	必須。APIのパスの一意のテキスト識別子。
コンテンツタイプ	MIMEタイプを選択します。
生データ本文	リクエスト本文のコンテンツを入力します。コンテンツタイプで application/x-www-form-urlencoded を選択した場合は、生データ本文パラメータをキーと値のペアで指定します。キーと値のペアごとに、新規行で開始します。例: a : b c : d e : f GETメソッドには適用されません。
JSON応答ファイル	オプション。JSON応答ファイルからswaggerファイルを生成する場合は、この応答ファイルをアップロードします。JSON応答ファイルを選択した場合は、RESTエンドポイントへの呼び出しが行われません。 JSON応答ファイルを選択しない場合は、RESTエンドポイントへの呼び出しが行われ、swaggerファイル生成用の応答を取得します。

REST V2コネクタによってサポートされるswagger定義オブジェクトとフィールドの詳細については、REST V2コネクタのドキュメントを参照してください。

［保存］

をクリックしてswaggerファイルを生成します。swaggerファイルのエントリは

［Swaggerファイル］

ページに表示されます。

Webサービスへの接続中にエラーが発生すると、Webサービスから取得した障害応答が

［Swaggerファイル］

ページに記録されます。

ダウンロードアイコン

をクリックしてSwaggerファイルをローカルディレクトリに保存します。

REST V2接続でswaggerファイルを使用するには、REST V2接続が作成されるSecure Agentシステムにこのファイルをコピーします。

REST V2接続用のSwaggerファイルの生成

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ