JSONtoXML 政策

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。 資訊

結果

這項政策會將 JavaScript Object Notation (JSON) 格式的訊息轉換為可延伸格式 標記語言 (XML)，提供數種控制郵件轉換方式的選項。

如果您要使用 XSL 轉換訊息，這項政策就特別實用。更新後 將 JSON 酬載轉換為 XML，搭配自訂樣式表使用 XSL 轉換政策， 執行所需的轉換作業

假設意圖是將 JSON 格式的要求轉換為 XML 格式的要求， 這項政策會附加至要求流程 (例如 Request / ProxyEndpoint / PostFlow)。

範例

如需在 JSON 和 XML 之間轉換的詳細討論，請參閱 http://community.apigee.com/articles/1839/converting-between-xml-and-json-what-you-need-to-k.html。

<JSONToXML name="jsontoxml">
    <Source>request</Source>
    <OutputVariable>request</OutputVariable>
</JSONToXML>

元素參照

以下是您可以為這項政策設定的元素和屬性。

<JSONToXML async="false" continueOnError="false" enabled="true" name="JSON-to-XML-1">
    <DisplayName>JSON to XML 1</DisplayName>
    <Source>request</Source>
    <OutputVariable>request</OutputVariable>
    <Options>
        <OmitXmlDeclaration>false</OmitXmlDeclaration>
        <DefaultNamespaceNodeName>$default</DefaultNamespaceNodeName>
        <NamespaceSeparator>:</NamespaceSeparator>
        <AttributeBlockName>#attrs</AttributeBlockName>
        <AttributePrefix>@</AttributePrefix>
        <ObjectRootElementName>Root</ObjectRootElementName>
        <ArrayRootElementName>Array</ArrayRootElementName>
        <ArrayItemElementName>Item</ArrayItemElementName>
        <Indent>false</Indent>
        <TextNodeName>#text</TextNodeName>
        <NullValue>I_AM_NULL</NullValue>
        <InvalidCharsReplacement>_</InvalidCharsReplacement>
    </Options>
</JSONToXML>

<JSONToXML>屬性

下表說明所有政策父項元素的共同屬性：

<DisplayName>元素

除 name 屬性外，一併使用 管理 UI Proxy 編輯器，使用不同的自然語言名稱。

<DisplayName>Policy Display Name</DisplayName>

<Source>元素

變數、要求或回應，包含您要轉換的 JSON 訊息 XML

如未定義 <Source>，系統會將其視為訊息 ( 政策附加至要求流程時的要求，或在附加政策時回應 回應流程)。

如果無法解析來源變數，或是無法解析為非訊息類型，就會顯示政策 擲回錯誤。

<Source>request</Source>

<OutputVariable>元素

儲存 JSON 的輸出格式轉換為 XML 格式。這個值通常會與 來源，通常會將 JSON 要求轉換為 XML 要求。

剖析 JSON 訊息的酬載並轉換為 XML，以及 HTTP Content-type XML 格式訊息的標頭已設為 text/xml;charset=UTF-8。

如未指定 OutputVariable，系統會將 source 視為 OutputVariable。舉例來說，如果 source 是 request， OutputVariable 則預設為 request。

<OutputVariable>request</OutputVariable>

<Options>/<OmitXmlDeclaration>

指定輸出中省略 XML 命名空間。預設值為 false。 也就是在輸出內容中加入命名空間

舉例來說，下列設定會將政策設為省略命名空間：

<OmitXmlDeclaration>true</OmitXmlDeclaration>

<Options>/<NamespaceBlockName>
<Options>/<DefaultNamespaceNodeName>
<Options>/<NamespaceSeparator>個元素

JSON 不支援命名空間，而 XML 文件往往需要命名空間。 NamespaceBlockName 可讓您定義 JSON 屬性，做為命名空間的來源 定義。(這表示來源 JSON 必須 提供的屬性，可對應至應用程式預期的命名空間 就會取用產生的 XML)。

例如下列設定：

<NamespaceBlockName>#namespaces</NamespaceBlockName>
<DefaultNamespaceNodeName>$default</DefaultNamespaceNodeName>
<NamespaceSeparator>:</NamespaceSeparator>

表示來源 JSON 中存在名為 #namespaces 的屬性 包含至少一個指定為預設值的命名空間。例如：

{
   "population": {
       "#namespaces": {
           "$default": "http://www.w3.org/1999/people",
           "exp": "http://www.w3.org/1999/explorers"
       },
       "person": "John Smith",
       "exp:person": "Pedro Cabral"
   }
}

會轉換為：

<population xmlns="http://www.w3.org/1999/people" xmlns:exp="http://www.w3.org/1999/explorers">
  <person>John Smith</person>
  <exp:person>Pedro Cabral</exp:person>
</population>

<Options>/<ObjectRootElementName>

<ObjectRootElementName> 會在您透過 JSON 轉換時指定根元素名稱，而這項作業沒有已命名的根元素 檔案轉換為 XML

舉例來說，如果 JSON 顯示如下：

{
  "abc": "123",
  "efg": "234"
}

然後將 <ObjectRootElementName> 設為：

<ObjectRootElementName>Root</ObjectRootElementName>

結果 XML 將顯示如下：

<Root>
   <abc>123</abc>
   <efg>234</efg>
</Root>

<Options>/<AttributeBlockName>
<Options>/<AttributePrefix>個元素

<AttributeBlockName> 可讓您指定 JSON 元素是 轉換為 XML 屬性 (而非 XML 元素)

舉例來說，下列設定會轉換名為 #attrs 轉換為 XML 屬性：

<AttributeBlockName>#attrs</AttributeBlockName>

下列 JSON 物件：

{
    "person" : {
        "#attrs" : {
            "firstName" : "John",
            "lastName" : "Smith"
        },        
        "occupation" : "explorer",
    }
}

轉換為下列 XML 結構：

<person firstName="John" lastName="Smith">
  <occupation>explorer</occupation>
</person>

<AttributePrefix> 會轉換開頭為指定前置字串的屬性 轉換為 XML 屬性屬性前置字元設為 @，例如：

<AttributePrefix>@</AttributePrefix>

轉換下列 JSON 物件：

{
"person" : {
   "@firstName" : "John",
   "@lastName" : "Smith"
   "occupation" : "explorer",

 }
}

新增至以下 XML 結構：

<person firstName="John" lastName="Smith">
  <occupation>explorer</occupation>
</person>

<Options>/<ArrayRootElementName>
<Options>/<ArrayItemElementName>元素

將 JSON 陣列轉換為具有指定父項和子項元素的 XML 元素清單 。

例如下列設定：

<ArrayRootElementName>Array</ArrayRootElementName>
<ArrayItemElementName>Item</ArrayItemElementName>

會轉換下列 JSON 陣列：

[
"John Cabot",
{
 "explorer": "Pedro Cabral"
},
"John Smith"
]

新增至以下 XML 結構：

<Array>
  <Item>John Cabot</Item>
  <Item>
    <explorer>Pedro Cabral</explorer>
  </Item>
  <Item>John Smith</Item>
</Array>

<Options>/<Indent>

指定 XML 輸出內容縮排。預設值為 false。 意思不會縮排

舉例來說，下列設定會設定這項政策，將輸出內容縮排：

<Indent>true</Indent>

如果 JSON 輸入內容的格式為：

{"n": [1, 2, 3] }

不含縮排的輸出內容如下：

<Array><n>1</n><n>2</n><n>3</n></Array>

啟用縮排後，輸出結果如下：

  <Array>
    <n>1</n>
    <n>2</n>
    <n>3</n>
  </Array>

<Options>/<TextNodeName>元素

將 JSON 屬性轉換為具有指定名稱的 XML 文字節點。舉例來說， 以下設定：

<TextNodeName>age</TextNodeName>

來轉換 JSON：

{
    "person": {
        "firstName": "John",
        "lastName": "Smith",
        "age": 25
    }
}

加入以下 XML 結構：

<person>
  <firstName>John</firstName>25<lastName>Smith</lastName>
</person>

如未指定 TextNodeName，系統會使用預設設定產生 XML 一個文字節點：

<person>
  <firstName>John</firstName>
  <age>25</age>
  <lastName>Smith</lastName>
</person>

<Options>/<NullValue>元素

表示空值。預設值為 NULL。

例如下列設定：

<NullValue>I_AM_NULL</NullValue>

{"person" : "I_AM_NULL"}

新增至下列 XML 元素：

<person></person>

如未指定空值值 (或 I_AM_NULL 以外的值)， 相同的酬載會轉換為：

<person>I_AM_NULL</person>

<Options>/<InvalidCharsReplacement>元素

為協助處理可能引發剖析器問題的無效 XML，請將這項設定替換 以字串產生無效 XML 的任何 JSON 元素。例如，下列 設定：

<InvalidCharsReplacement>_</InvalidCharsReplacement>

轉換這個 JSON 物件

{
    "First%%%Name": "John"
}

加入以下 XML 結構：

<First_Name>John<First_Name>

使用須知

在一般中介服務的情況下，傳入請求流程中的 JSON 到 XML 政策通常會是 並比對傳出回應流程中的 XMLtoJSON 政策。以這種方式結合政策 可以為原生支援 XML 的服務公開 JSON API。

將預設的 (空白) JSON 套用至 XML 政策，並反覆新增 所需設定元素

適用於不同用戶端應用程式可能需以 JSON 格式使用 API 的情況 和 XML，只要將 JSON 設為 XML，並將 XML 設為 要有條件執行的 JSON 政策。請參閱流程變數和條件。 實作這個情境

結構定義

錯誤參考資料

本節說明在這項政策觸發錯誤時，所傳回的錯誤代碼和錯誤訊息，以及 Edge 所設定的錯誤變數。 請務必瞭解這份資訊，以便瞭解您是否要擬定錯誤規則， 處理錯誤詳情請參閱這篇文章 瞭解政策錯誤和處理方式 發生錯誤

執行階段錯誤

執行政策時，可能會發生這些錯誤。

部署錯誤

無。

錯誤變數

系統會在發生執行階段錯誤時設定這些變數。詳情請參閱重要須知 政策錯誤。

錯誤回應範例

{
  "fault": {
    "faultstring": "JSONToXML[JSON-to-XML-1]: Source xyz is not available",
    "detail": {
      "errorcode": "steps.json2xml.SourceUnavailable"
    }
  }
}

錯誤規則範例

<FaultRule name="JSON To XML Faults">
    <Step>
        <Name>AM-SourceUnavailableMessage</Name>
        <Condition>(fault.name Matches "SourceUnavailable") </Condition>
    </Step>
    <Step>
        <Name>AM-BadJSON</Name>
        <Condition>(fault.name = "ExecutionFailed")</Condition>
    </Step>
    <Condition>(jsontoxml.JSON-to-XML-1.failed = true) </Condition>
</FaultRule>

相關主題

• XML 到 JSON：XML 到 JSON 政策
• XSL 轉換：XSL 轉換政策