validate

validate ポリシーを使用して、アセンブリー・フロー内のペイロードをスキーマと突き合わせて検証します。

制約事項: validate ポリシーは、DataPower® Gateway にのみ使用できます。

validate ポリシーの形式は次のとおりです。

- validate:
  title: title
  description: description
  definition: swagger_schema_definition_to_be_used

このポリシーを適用するには、execute フィールドを指定した assembly 拡張を OpenAPI (Swagger 2.0) 定義ファイルに追加します。

以下の表に、このポリシーのプロパティーを示します。

表 1. validate ポリシーのプロパティー
プロパティー	必須	説明	データ型
title	いいえ	ポリシーのタイトル。	ストリング
description	いいえ	ポリシーの説明。	ストリング
definition	はい	ペイロードの検証に使用されるスキーマ。有効は値は以下のとおりです。 `request`: この操作に対する要求パラメーターの「タイプ」フィールドに指定されているスキーマ定義に照らして要求の入力を検証するには、この値を選択します。要求パラメーターの作成方法について詳しくは、操作の構成を参照してください。 `response`: この操作に対する応答パラメーターの「スキーマ」フィールドに指定されているスキーマ定義に照らして、クライアント・アプリケーションに返される応答を検証するには、この値を選択します。応答パラメーターの作成方法について詳しくは、操作の構成を参照してください。スキーマ定義の名前の形式は次のとおりです。 `#/definitions/schema_name` スキーマは、OpenAPI (Swagger 2.0) ファイルの `definitions:` セクションに定義する必要があります。	ストリング

API Designer アセンブリー・エディターを使用して、組み込みポリシーを API に追加することで、validate ポリシーを適用することもできます。詳しくは、『組み込みポリシー』セクションの Validate (validate) を参照してください。

例 1

validate:
  title: validate the response
  definition: #/definitions/RouteOutput

最終更新: 2017 年 10 月 31 日