將 XML 轉換成 JSON
適用於:所有 APIM 層
xml-to-json
原則將要求或回應本文從 XML 轉換成 JSON。 此原則可用於將架構在「僅使用 XML 的後端 Web 服務」上的 API 現代化。
注意
請依照原則陳述式中提供的順序,來設定原則的元素和子元素。 深入了解如何設定或編輯 APIM 原則。
原則陳述式
<xml-to-json kind="javascript-friendly | direct" apply="always | content-type-xml" consider-accept-header="true | false" always-array-child-elements="true | false"/>
屬性
屬性 | 描述 | 是必要欄位 | 預設 |
---|---|---|---|
kind | 此屬性必須設為下列其中一個值。 - javascript-friendly :轉換後的 JSON 會使用 JavaScript 開發人員熟悉的格式。- direct :轉換後的 JSON 可反映原始 XML 文件的結構。允許使用原則運算式。 |
Yes | N/A |
套用 | 此屬性必須設為下列其中一個值。 - always :一律轉換。- content-type-xml :只有當回應中的 Content-type 標頭指出 XML 存在時才轉換。允許使用原則運算式。 |
Yes | N/A |
consider-accept-header | 此屬性必須設為下列其中一個值。 - true :如果在要求的 Accept 標頭中要求 JSON,才套用轉換。- false :一律套用轉換。允許使用原則運算式。 |
No | true |
always-array-child-elements | 此屬性必須設為下列其中一個值。 - true - 一律將子項目轉換成 JSON 陣列。- false - 只將多個子項目轉換成 JSON 陣列。 將單一子項目轉換成 JSON 物件。允許使用原則運算式。 |
No | false |
使用方式
範例
<policies>
<inbound>
<base />
</inbound>
<outbound>
<base />
<xml-to-json kind="direct" apply="always" consider-accept-header="false" />
</outbound>
</policies>
相關原則
相關內容
如需使用原則的詳細資訊,請參閱:
- 教學課程:轉換及保護 API
- 原則參考,取得原則陳述式及其設定的完整清單
- 原則運算式
- 設定或編輯原則
- 重複使用原則設定
- 原則程式碼片段存放庫 (英文)
- 使用 Microsoft Azure Copilot 撰寫原則