xml-to-json

使用 xml-to-json 策略将 API 的上下文有效内容从可扩展标记语言 (XML) 格式转换为 JavaScript 对象表示法 (JSON)。

网关支持

表 1. 该表显示了支持此策略的网关以及对应的策略版本
网关 策略版本
DataPower® Gateway (v5 compatible) 1.0.0
DataPower API Gateway 2.0.0

本主题说明如何在 OpenAPI 源中配置策略；有关如何在程序集用户界面中配置策略的详细信息，请参阅 XML 到 JSON。

关于

xml-to-json 策略具有以下结构:
- xml-to-json:
   version: version
   title: Title
   description: Description
注: 如果您正在使用 DataPower API Gateway，那么 xml-to-json 策略的输入必须是已解析的数据。 生成已解析数据的一种方法是在组合件流中的 xml-to-json 策略之前使用 parse 策略，这将提供解析操作的显式控制。

属性

下表描述了该策略的属性：
表 2. 策略属性
属性 必需 描述 数据类型
version 是 策略版本号 字符串
title 是 策略的标题。 字符串
description False 对策略的描述。 字符串
DataPower API Gateway onlyinput False 要转换的输入消息。 在 API 上下文中指定变量的名称。 variableName.body 消息有效内容，表示要转换的 JSON 输入。 此变量的缺省值为 message，message.body 为缺省输入。 字符串
DataPower API Gateway onlyoutput False 用于存储转换结果的输出消息。 指定 API 上下文中变量的名称。 variableName.body 表示从 JSON 格式转换为 XML 格式的结果。 如果指定的输入消息为缺省消息，那么缺省输出为 message.body。 否则，例如当输入消息为 my-message-variable 变量时，缺省输出为 my-message-variable.body。

在 API 上下文中，变量不能为任何只读变量。

 字符串
DataPower API Gateway onlyconversionType False 用于确定输出目标格式的转换类型。 提供了以下选项：
  • badgerFish：使用 BadgerFish 转换来确定输出的目标转换格式。
  • apicv5：apicv5 转换用于确定输出的目标转换格式。
 字符串

示例

以下是 xml-to-json 策略的示例：
- xml-to-json:
   version: 1.0.0
   title: XML to JSON transform
   description: Transforms XML message body to JSON format