DataWorks:ベストプラクティス: APIリクエストパラメータをオプションパラメータとして指定する

パラメータの詳細については、「コードレス UI を使用して API を作成する」をご参照ください。

次に、次の図に示すように、リクエストパラメータパネルに表示されるフィールドの [必須] パラメータを設定できます。

• フィールドの [必須] を選択すると、そのフィールドは必須リクエストパラメータになります。この場合、現在の API を呼び出すときに、リクエストパラメータの値を指定する必要があります。指定しないと、システムはパラメータ検証例外を報告し、API 呼び出しは失敗します。

• フィールドの [必須] を選択しないと、そのフィールドはオプションリクエストパラメータになります。この場合、現在の API を呼び出すときに、リクエストパラメータの値を指定するか、リクエストパラメータを空のままにすることができます。現在の API を呼び出すときにリクエストパラメータを空のままにすると、リクエストパラメータはクエリ条件として使用されません。

• ケース 1：uid および gender リクエストパラメータのそれぞれに値を指定します。次のコードは、クエリリクエストを示しています。

  SELECT uid, gender, age_range, zodiac
  FROM ods_user_info_d
  WHERE uid = 0016359810821
  AND gender = 'female';

• ケース 2：uid リクエストパラメータに値を指定し、gender リクエストパラメータを空のままにします。次のコードは、クエリリクエストを示しています。

  SELECT uid, gender, age_range, zodiac
  FROM ods_user_info_d
  WHERE uid = 0016359810821;

パラメータの詳細については、「コードエディターを使用して API を作成する」をご参照ください。

SELECT uid, gender, age_range, zodiac
FROM ods_user_info_d
<where>
    <if test='gender!=null'>  // gender が null でない場合
    gender = ${gender}
    </if>
    and uid = ${uid}
</where>

次に、次の図に示すように、リクエストパラメータパネルに表示されるフィールドの [必須] パラメータを設定できます。

• ケース 1：uid および gender リクエストパラメータのそれぞれに値を指定します。次のコードは、クエリリクエストを示しています。

  SELECT uid, gender, age_range, zodiac
  FROM ods_user_info_d
  WHERE uid = 0016359810821
  AND gender = 'female';

• ケース 2：uid リクエストパラメータに値を指定し、gender リクエストパラメータを空のままにします。次のコードは、クエリリクエストを示しています。

  SELECT uid, gender, age_range, zodiac
  FROM ods_user_info_d
  WHERE uid = 0016359810821;