DataPower Gateway

validate - DataPower Gateway (v5 compatible)

使用 validate 策略针对模式验证组合件流中的有效内容。

网关支持

注: 此页面描述 DataPower® Gateway (v5 compatible)中的 validate 策略实现。 如果您正在使用该 DataPower API Gateway工具,请参阅 validate - DataPower API Gateway

有关不同类型网关的信息,请参阅 API Connect “网关类型 ”。

表 1. 显示哪些网关支持此策略以及对应策略版本的表格
网关 策略版本
DataPower Gateway (v5 compatible) 1.0.0

本主题介绍了如何在 OpenAPI 源中配置策略;有关如何在程序集用户界面中配置策略的详细信息,请阅“验证 - DataPower Gateway (与 v5 兼容)”。

限制:
  • 表示 XML 的模式只能引用一个 XML 名称空间。
  • 模式不能引用多态 XML 元素。
  • 验证适用于 message.body 变量,但不适用于任何其他输出/上下文变量。 如果 invoke 策略包含配置的响应对象变量,那么不会设置 message.body,且无法进行验证。
  • 如果在 API 的模式定义中使用 multipleOf 关键字,那么由于舍入行为,指定的值必须满足以下条件,否则在调用 API 时验证将失败:
    • 值不得小于 0.000000999999999999999848869
    • 如果值大于 1,那么小数点前的数值不得大于 999999999999999934463

关于

validate 策略具有以下格式:
- validate:
  version: version
  title: title
  description: description
  definition: swagger_schema_definition_to_be_used

通过将具有 execute 字段的 assembly 扩展添加到 OpenAPI 定义文件来应用此策略。

属性

下表描述了该策略的属性:
表 2. validate 策略属性
属性 必需 描述 数据类型
version 策略版本号 字符串
title False 策略的标题。 字符串
description False 策略的描述。 字符串
definition 要用于验证有效内容的模式。
有效值:
  • request:选择该值以针对类型字段中为该操作的请求参数指定的模式定义对请求输入进行验证。 有关如何创建请求参数的信息,请参阅 配置操作
  • response:选择该值以针对模式字段中为该操作的响应参数指定的模式定义,对返回到客户机应用程序的响应进行验证。 有关如何创建响应参数的信息,请参阅 配置操作
  • 模式定义的名称,格式如下:
     #/definitions/schema_name
    必须在 OpenAPI 文件的 definitions: 部分中定义模式。
字符串

您还可以通过使用 API Designer 组合件编辑器向 API 添加内置策略来应用 validate 策略。 如需了解更多信息,请阅“内置策略”部分中的“Validate - DataPower Gateway (兼容 v5 )”。

示例 1

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