XML to JSON
XML to JSON ポリシーは、API のコンテキスト・ペイロードを Extensible Markup Language (XML) 形式から JavaScript Object Notation (JSON) 形式に変換するために使用します。
ゲートウェイのサポート
ゲートウェイ | ポリシーのバージョン |
---|---|
DataPower® Gateway (v5 互換) | 1.0.0 |
DataPower API Gateway | 2.0.0 |
このトピックでは、アセンブリー・ユーザー・インターフェースでのポリシーの構成方法について説明します。OpenAPI ソースでのポリシーの構成方法について詳しくは、xml-to-jsonを参照してください。
概要
XML to JSON ポリシーでは、BadgerFish に基づく単純な規則を使用して、API コンテキスト・ペイロードが XML から JSON に変換されます。XML コンテンツは、属性と名前空間を含めて保持されます。追加の構成は不要です。いくつかの例を含む BadgerFish 規則について詳しくは、BadgerFish を参照してください。
- REST
- SOAP
組み込みポリシーをフローに追加するために API 定義を作成する場合は、API Manager アセンブリー・ビューを使用します。
このポリシーは、変換を実行する必要があるポイントのフローに付加する必要があります。例えば、XML 形式の要求を JSON 形式の要求に変換する必要がある場合は、このポリシーを要求フローに付加します。
ポリシーは、message.body のコンテキストが存在する場合は message.body から入力を読み取り、存在しない場合は request.body から入力を読み取って、message.body に出力を書き込みます。
プロパティー
以下の表に、このポリシーのプロパティーをリストします。表には、プロパティーが必須かどうか、入力用の有効な値とデフォルト値、および値のデータ型が示されています。
プロパティー・ラベル | 必須 | 説明 | データ型 |
---|---|---|---|
タイトル | はい | ポリシーのタイトル。 デフォルト値は、xml-to-json です。 |
ストリング |
説明 | いいえ | ポリシーの説明。 | ストリング |
![]() |
いいえ | 変換する入力メッセージ。API コンテキストの変数の名前を指定します。 variableName.body (メッセージ・ペイロード) が、変換対象の XML 入力データを表します。この変数のデフォルト値は message であり、message.body がデフォルトの入力です。 | ストリング |
![]() |
いいえ | 変換結果を保管するための出力メッセージ。API コンテキストの変数の名前を指定します。 variableName.body が、XML 形式から JSON 形式への変換の結果を表します。指定された入力メッセージがデフォルトのメッセージである場合、デフォルトの出力は message.body です。それ以外の場合、例えば、入力メッセージが変数 my-message-variable である場合は、デフォルトの出力は my-message-variable.body となります。 変数を、API コンテキストの読み取り専用にすることはできません。 |
ストリング |
![]() |
いいえ | 出力のターゲット形式を決定する変換タイプ。使用可能なオプションは次のとおりです。
|
ストリング |
例
<a>hello</a>
は、次のようになります。{ "a": { "$" : "hello" } }
<a type="world">hello</a>
は、次のようになります。{ "a": { "$" : "hello", "@type" : "world" } }