parse
parse 策略可用于控制输入文档的解析。当输入文档为 JSON 字符串时,将解析而非复制该字符串。
| 网关 | 策略版本 |
|---|---|
| DataPower® API Gateway | 2.0.0 |
本主题描述如何在 OpenAPI 源中配置策略;有关如何在组合件用户界面中配置策略的详细信息,请参阅解析。
关于
parse 策略的格式如下:
- parse:
version: version
title: title
description: description use-content-type: request_header_usage_setting
parse-settings-reference:
.
.
.
references_to_parse_settings
.
.
.
input: input_message
output: output_message
属性
| 属性 | 必需 | 描述 | 数据类型 |
|---|---|---|---|
| version | 否 | 策略版本号。 | 字符串 |
| title | 否 | 策略的标题。 | 字符串 |
| description | 否 | 对策略的描述。 | 字符串 |
| use-content-type | 否 | 如果启用此设置并且解析设置配置为检测文档类型,那么解析操作将使用请求头中指定的 Content-Type。 如果启用此设置并且为 JSON 或 XML 配置解析设置中的文档类型,那么解析操作将使用请求头中指定的 Content-Type,并且如果请求头中的 Content-Type 与解析设置不匹配,那么会失败。 只有当期望的 Content-Type 为 JSON 或 XML 时,才能启用此设置。 如果未启用此设置,那么解析操作将使用解析设置中指定的文档类型,或者如果将解析设置配置为检测文档类型,那么将使用检测到的文档类型。 缺省值为 false。 |
布尔值 |
|
否 | 现有的有效对象,可从中检索动态对象的缺省属性值。 | 字符串 |
|
否 | 已合并到动态对象中的序列化 XML 或 JSON 属性形式的文字串。这些属性优先于任何现有缺省属性。 | 字符串 |
|
否 | 表示指定上下文的 URL,可从中检索已合并到动态对象中的序列化的 XML 或 JSON 属性。这些属性优先于任何现有文字或缺省属性。 | 字符串 |
| input | 否 | API 上下文中变量的名称。变量的 body 字段的内容即策略的输入。缺省变量名称为 message。 | 字符串 |
| output | 否 | API 上下文中变量的名称。变量的 body 字段的内容即解析操作的输出。已解析的文档的解析度量可存储在消息的不同部分中。缺省变量名称与输入名称相同,因此缺省情况下输出消息将覆盖输入消息。 | 字符串 |
parse policy example
- parse:
version: 2.0.0
title: my-parse-policy use-content-type: true
parse-settings-reference:
default: my-parse
input: input-message
output: output-message