xml-to-json

xml-to-json ポリシーを使用して、API のコンテキスト・ペイロードを Extensible Markup Language (XML) 形式から JavaScript Object Notation (JSON) 形式に変換します。

ゲートウェイのサポート

表 1. このポリシーをサポートするゲートウェイと、対応するポリシーのバージョンを示す表
ゲートウェイ	ポリシーのバージョン
DataPower® Gateway (v5 compatible)	1.0.0
DataPower API Gateway	2.0.0

このトピックでは、 OpenAPI ソースでのポリシーの構成方法について説明します。アセンブリー・ユーザー・インターフェースでのポリシーの構成方法について詳しくは、 XML to JSONを参照してください。

製品情報

xml-to-json ポリシーの構造は以下のとおりです。

- xml-to-json:
   version: version
   title: Title
   description: Description

注: DataPower API Gatewayを使用している場合、 xml-to-json ポリシーへの入力は解析済みデータでなければなりません。解析済みデータを生成する 1 つの方法は、アセンブリー・フローで xml-to-json ポリシーの前に parse ポリシーを使用することです。これにより、解析アクションが明示的に制御されます。

プロパティ－

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

表 2. ポリシーのプロパティー
プロパティー	必須	説明	データ・タイプ
version	はい	ポリシーのバージョン番号	ストリング
title	はい	ポリシーのタイトル。	ストリング
description	いいえ	ポリシーの説明。	ストリング
input	いいえ	変換する入力メッセージ。 API コンテキスト内の変数の名前を指定します。 `variableName.body`、メッセージ・ペイロード。変換する JSON 入力を表します。この変数のデフォルト値は `message` であり、`message.body` がデフォルトの入力です。	ストリング
output	いいえ	変換結果を保管するための出力メッセージ。 API コンテキストの変数の名前を指定します。 `variableName.body` が、JSON 形式から XML 形式への変換の結果を表します。指定された入力メッセージがデフォルトのメッセージである場合、デフォルトの出力は `message.body` です。それ以外の場合、例えば、入力メッセージが変数 `my-message-variable` である場合は、デフォルトの出力は `my-message-variable.body` となります。変数を、API コンテキストの読み取り専用にすることはできません。	ストリング
conversionType	いいえ	出力のターゲット形式を決定する変換タイプ。使用可能なオプションは次のとおりです。 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