json-to-xml

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

ゲートウェイのサポート

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

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

製品情報

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

プロパティ－

以下の表に、このポリシーのプロパティーを示します。
表 2. ポリシーのプロパティー
プロパティー 必須 説明 データ・タイプ
version はい ポリシーのバージョン番号 ストリング
title はい ポリシーのタイトル。 ストリング
description いいえ ポリシーの説明。 ストリング
DataPower API Gateway onlyinput いいえ 変換する入力メッセージ。 API コンテキスト内の変数の名前を指定します。 variableName.body、 メッセージ・ペイロード。変換する JSON 入力を表します。 この変数のデフォルト値は message であり、message.body がデフォルトの入力です。 ストリング
DataPower API Gateway onlyoutput いいえ 変換結果を保管するための出力メッセージ。 API コンテキストの変数の名前を指定します。 variableName.body が、JSON 形式から XML 形式への変換の結果を表します。 指定された入力メッセージがデフォルトのメッセージである場合、デフォルトの出力は message.body です。 それ以外の場合、例えば、入力メッセージが変数 my-message-variable である場合は、デフォルトの出力は my-message-variable.body となります。

変数を、API コンテキストの読み取り専用にすることはできません。

 ストリング
DataPower API Gateway onlyconversionType いいえ 出力のターゲット形式を決定する変換タイプ。 使用可能なオプションは次のとおりです。
  • None: 出力の変換が行われません。
  • badgerFish: BadgerFish 規則は、出力のターゲット変換形式を決めるために使用されます。
 ストリング
root-element-name はい 結果の XML 文書のルート・エレメント名。 このプロパティーが使用されるのは、入力 JSON 文書が階層構造になっておらず、最上位プロパティーが複数存在する場合、または always-output-root-element プロパティーが true に設定されている場合のみです。  
always-output-root-element はい XML 文書を整形式にする必要がない場合であっても、ポリシーで常にルート・エレメントを出力する場合は、このプロパティーを true に設定します。 ブール値
unnamed-element-name いいえ JSON 配列エレメントに使用される XML エレメント名です。 ストリング

例

以下に、json-to-xml ポリシーの例を示します。
- json-to-xml:
   version: 1.0.0
   title: JSON to XML transform
   description: Transforms JSON message body to XML format