クエリパラメーターとヘッダーの検証

APIkit ルーター​は、ヘッダーとクエリパラメーターを検証し、API 仕様内で指定された属性に制限します。

  1. Studio で、​[APIkit Router (APIkit ルーター)]​ を選択します。

    [APIkit Router (APIkit ルーター)] が強調表示されています
  2. ルーター設定の ​[Edit (編集)]​ をクリックします。

    [APIkit Router (APIkit ルーター)] タブで、[Edit (編集)] ボタンが強調表示されています
  3. [Query Parameters Strict Validations (クエリパラメーターの厳格な検証)]​ を選択して、API 仕様で定義されているクエリパラメーターのみを使用可能にします。

  4. [Headers Strict Validations (ヘッダーの厳格な検証)]​ を選択して、API 仕様で定義されているヘッダーのみを使用可能にします。

    [Router Configuration (ルーター設定)] タブで、*[Query Parameters Strict Validations (クエリパラメーターの厳格な検証)]* と *[Headers Strict Validations (ヘッダーの厳格な検証)]* が強調表示されています

次のように APIkit 設定コードを更新することで、ヘッダーとクエリパラメーターを検証するように ​[APIkit Router (APIkit ルーター)]​ を設定することもできます。

<apikit:config  name="api-config"
                api="api.raml"
                outboundHeadersMapName="outboundHeaders"
                httpStatusVarName="httpStatus"
                queryParamsStrictValidation="true"
                headersStrictValidation="true" />

クエリパラメーターとヘッダーの検証の無効化

レイテンシーを最小限に抑えるには、クエリパラメーターとヘッダーの検証を無効にします。

  1. Studio で、​[APIkit Router (APIkit ルーター)]​ を選択します。

    [APIkit Router (APIkit ルーター)] が強調表示されています
  2. ルーター設定の ​[Edit (編集)]​ をクリックします。

    [APIkit Router (APIkit ルーター)] タブで、[Edit (編集)] ボタンが強調表示されています
  3. [Disable Validation (検証の無効化)]​ を選択します。

    [Router Configuration (ルーター設定)] タブで、*[Disable Validation (検証の無効化)]* オプションが強調表示されています

次のように APIkit 設定コードを更新することで、クエリパラメーターとヘッダーの検証を無効にしてレイテンシーを最小限に抑えることもできます。

<apikit:config  name="api-config"
                api="api.raml"
                outboundHeadersMapName="outboundHeaders"
                httpStatusVarName="httpStatus"
                disableValidations="true" />