サービス接続用のサーバー変数の追加

サービス接続を作成したら、サーバー・タブに移動し、サーバー・インスタンスのURLを編集してサーバー変数を追加できます。

ノート:

23.10リリース後に作成されたサービス接続の場合、サーバー変数は、サービス接続に関連付けられたバックエンドから更新する必要があります。詳細は、「バックエンドのサーバー変数の追加」を参照してください。

インスタンスURLに{version}などの有効なURIテンプレート式を入力すると、サーバー変数が自動的に作成され、サーバー・エディタの「サーバー変数」セクションに表示されます。変数リストを作成、編集または順序変更することもできます。サーバー変数ごとにデフォルト値を設定する必要があります。

https://restcountries.com/v3.1/lang/germanを例として使用して、これがどのように機能するかを見てみましょう:

サーバー・インスタンスURLは、https://restcountries.com/{version}/langとして表すことができます。
ここでは、shown:のように、v3.1のデフォルト値を持つサーバー変数{version}が1つのみ存在
図server-variable-example.pngの説明
エンドポイントは/{language}です。
ここで、languageはエンドポイント・パスの一部であるため、パス・パラメータです。この例はインスタンスURLの外部にあるため、サーバー変数にはできません。デフォルト値はgermanで、タイプは文字列です。
完全なURLはhttps://restcountries.com/{version}/lang/{language}になります。
置換後(サーバー変数{version}の場合はv3.1、languageパス・パラメータの場合はgerman)は、開始したインスタンスURL https://restcountries.com/v3.1/lang/germanを表します。

サーバーURLで変数(または複数の変数)を追加または変更する方法を次に示します:

サービス接続の「サーバー」タブを開きます。
新しいサーバー変数を追加する(または既存の変数を変更する)サーバー・インスタンスの右側にある「編集」をインスタンスURLにクリックします。
「編集サーバー」ダイアログが表示されます。
「インスタンスURL」フィールドに、必要な変数を追加します。
たとえば、「1.2」などのURLのバージョン番号を変数 {version}に置き換えることができます。これを行うと、「サーバー変数」に表示されたURLに追加した変数が、インスタンスURLの「説明」フィールドの下に表示されます。追加した変数が「名前」フィールドに表示されます。
「説明」フィールドに説明を入力し、「デフォルト」フィールドにデフォルト値を設定します。
終了したら「完了」をクリックするか、「+値の追加」をクリックして別の値を追加します。複数の値を含むリストを作成するには、「メニュー」をクリックし、「値リストの作成」を選択します。次に、値を追加した後、またはコントロールを使用してデフォルト値を設定するか、値リストを並べ替えます。デフォルト値は、リストの先頭に表示されます。「削除」を使用して、不要な値を破棄できます。
必要に応じて、URLに別の変数を追加します。
定義する各変数の値を設定する必要があります。そうしないと、値が必須であることを示すメッセージが表示されます。デフォルト値を入力し、「完了」をクリックします。
「保存」をクリックします。

ヒント:

エンドポイント・エディタの「テスト」タブに、新しい「サーバー変数」タブがあります。このタブを使用して、エンドポイントのテスト時にサーバー変数の値をテストできます。定義した値リストを使用すると、URLを効率的に変更して各バージョンをテストできます。この機能を使用するプロセスは、ここで説明した処理とよく似ています。