Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Apa
Kebijakan ini mengonversi pesan dari format JavaScript Object Notation (JSON) menjadi extensible markup language (XML), yang memberi Anda beberapa opsi untuk mengontrol cara pesan dikonversi.
Kebijakan ini sangat berguna jika Anda ingin mengubah pesan menggunakan XSL. Setelah mengonversi payload JSON ke XML, gunakan kebijakan Transformasi XSL dengan style sheet kustom untuk melakukan transformasi yang Anda perlukan.
Dengan asumsi bahwa intent tersebut adalah untuk mengonversi permintaan berformat JSON menjadi permintaan berformat XML, kebijakan tersebut akan dilampirkan ke Flow permintaan (misalnya, Request / ProxyEndpoint / PostFlow).
Contoh
Untuk diskusi mendetail tentang konversi antara JSON dan XML, lihat http://community.apigee.com/articles/1839/converting-between-xml-and-json-what-you-need-to-k.html.
Mengonversi permintaan
<JSONToXML name="jsontoxml"> <Source>request</Source> <OutputVariable>request</OutputVariable> </JSONToXML>
Konfigurasi ini mengambil pesan permintaan berformat JSON sebagai sumber, lalu membuat pesan berformat XML yang diisi dalam OutputVariable request
. Edge otomatis menggunakan konten variabel ini sebagai pesan untuk langkah pemrosesan berikutnya.
Referensi elemen
Berikut adalah elemen dan atribut yang dapat Anda konfigurasi di kebijakan ini.
<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>
Atribut <JSONToXML>
Tabel berikut menjelaskan atribut yang sama untuk semua elemen induk kebijakan:
Atribut | Deskripsi | Default | Ketersediaan |
---|---|---|---|
name |
Nama internal kebijakan. Nilai atribut Atau, gunakan elemen |
T/A | Wajib |
continueOnError |
Setel ke Setel ke |
false | Opsional |
enabled |
Setel ke Setel ke |
true | Opsional |
async |
Atribut ini sudah tidak digunakan lagi. |
false | Tidak digunakan lagi |
Elemen <DisplayName>
Gunakan selain atribut name
untuk memberi label kebijakan di
editor proxy UI pengelolaan dengan nama natural-language yang berbeda.
<DisplayName>Policy Display Name</DisplayName>
Default |
T/A Jika Anda menghapus elemen ini, nilai atribut |
---|---|
Ketersediaan | Opsional |
Jenis | String |
Elemen <Source>
Variabel, permintaan atau respons, yang berisi pesan JSON yang ingin Anda konversi ke XML.
Jika <Source>
tidak ditentukan, kebijakan akan diperlakukan sebagai pesan (yang di-resolve
untuk meminta ketika kebijakan dilampirkan ke alur permintaan, atau respons saat kebijakan dilampirkan
ke alur respons).
Jika variabel sumber tidak dapat di-resolve, atau di-resolve menjadi jenis non-pesan, kebijakan akan menampilkan error.
<Source>request</Source>
Default | permintaan atau respons, ditentukan oleh tempat kebijakan ditambahkan ke alur proxy API |
Kehadiran | Opsional |
Jenis | pesan |
Elemen <OutputVariable>
Menyimpan output konversi format JSON ke XML. Nilai ini biasanya sama dengan sumber, yang berarti biasanya permintaan JSON dikonversi ke permintaan XML.
Payload pesan JSON diuraikan dan dikonversi menjadi XML, dan header Jenis Konten HTTP
dari pesan berformat XML ditetapkan ke text/xml;charset=UTF-8
.
Jika OutputVariable
tidak ditentukan, source
akan diperlakukan sebagai
OutputVariable
. Misalnya, jika source
adalah request
,
maka OutputVariable
ditetapkan secara default ke request
.
<OutputVariable>request</OutputVariable>
Default | permintaan atau respons, ditentukan oleh tempat kebijakan ditambahkan ke alur proxy API |
Kehadiran | Elemen ini wajib ada jika variabel yang ditentukan dalam elemen <Source> adalah string jenis. |
Jenis | pesan |
<Opsi>/<OmitXmlDeclaration>
Menentukan untuk menghilangkan namespace XML dari output. Nilai defaultnya adalah false
yang berarti menyertakan namespace dalam output.
Misalnya, setelan berikut mengonfigurasi kebijakan untuk menghilangkan namespace:
<OmitXmlDeclaration>true</OmitXmlDeclaration>
<Opsi>/<NamespaceBlockName>
<Options>/<DefaultNamespaceNodeName>
Elemen <Options>/<NamespaceSeparator>
JSON tidak mendukung namespace, sementara dokumen XML sering kali memerlukannya.
NamespaceBlockName
memungkinkan Anda menentukan properti JSON yang berfungsi sebagai sumber definisi namespace dalam XML yang dihasilkan oleh kebijakan. (Artinya, JSON sumber harus menyediakan properti yang dapat dipetakan ke dalam namespace yang diharapkan oleh aplikasi yang menggunakan XML yang dihasilkan.)
Misalnya, setelan berikut:
<NamespaceBlockName>#namespaces</NamespaceBlockName> <DefaultNamespaceNodeName>$default</DefaultNamespaceNodeName> <NamespaceSeparator>:</NamespaceSeparator>
menunjukkan bahwa properti yang disebut #namespaces
ada di JSON sumber yang berisi setidaknya satu namespace yang ditetapkan sebagai default. Contoh:
{ "population": { "#namespaces": { "$default": "http://www.w3.org/1999/people", "exp": "http://www.w3.org/1999/explorers" }, "person": "John Smith", "exp:person": "Pedro Cabral" } }
dikonversi menjadi:
<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>
<Opsi>/<ObjectRootElementName>
<ObjectRootElementName> menentukan nama elemen root saat Anda melakukan konversi dari JSON, yang tidak memiliki elemen root bernama, ke XML.
Misalnya, jika JSON muncul sebagai:
{ "abc": "123", "efg": "234" }
Dan tetapkan <ObjectRootElementName> sebagai:
<ObjectRootElementName>Root</ObjectRootElementName>
XML yang dihasilkan akan muncul sebagai:
<Root> <abc>123</abc> <efg>234</efg> </Root>
Elemen <Options>/<AttributeBlockName>
<Options>/<AttributePrefix>
<AttributeBlockName>
memungkinkan Anda menentukan kapan elemen JSON
dikonversi menjadi atribut XML (bukan elemen XML).
Misalnya, setelan berikut mengonversi properti di dalam sebuah objek bernama
#attrs
menjadi atribut XML:
<AttributeBlockName>#attrs</AttributeBlockName>
Objek JSON berikut:
{ "person" : { "#attrs" : { "firstName" : "John", "lastName" : "Smith" }, "occupation" : "explorer", } }
dikonversi ke struktur XML berikut:
<person firstName="John" lastName="Smith"> <occupation>explorer</occupation> </person>
<AttributePrefix>
mengonversi properti yang dimulai dengan awalan yang ditentukan
menjadi atribut XML. Tempat awalan atribut ditetapkan ke @
, misalnya:
<AttributePrefix>@</AttributePrefix>
Mengonversi objek JSON berikut:
{ "person" : { "@firstName" : "John", "@lastName" : "Smith" "occupation" : "explorer", } }
ke struktur XML berikut:
<person firstName="John" lastName="Smith"> <occupation>explorer</occupation> </person>
<Options>/<ArrayRootElementName>
Elemen <Options>/<ArrayItemElementName>
Mengonversi array JSON menjadi daftar elemen XML dengan nama elemen induk dan turunan yang ditetapkan.
Misalnya, setelan berikut:
<ArrayRootElementName>Array</ArrayRootElementName> <ArrayItemElementName>Item</ArrayItemElementName>
mengonversi array JSON berikut:
[ "John Cabot", { "explorer": "Pedro Cabral" }, "John Smith" ]
ke dalam struktur XML berikut:
<Array> <Item>John Cabot</Item> <Item> <explorer>Pedro Cabral</explorer> </Item> <Item>John Smith</Item> </Array>
<Opsi>/<Indentasi>
Menentukan untuk mengindentasi output XML. Nilai defaultnya adalah false
yang berarti jangan mengindentasi.
Misalnya, setelan berikut akan mengonfigurasi kebijakan untuk mengindentasi output:
<Indent>true</Indent>
Jika input JSON dalam bentuk:
{"n": [1, 2, 3] }
Maka output tanpa intdentasi adalah:
<Array><n>1</n><n>2</n><n>3</n></Array>
Dengan mengaktifkan indentasi, output-nya adalah:
<Array> <n>1</n> <n>2</n> <n>3</n> </Array>
Elemen <Options>/<TextNodeName>
Mengonversi properti JSON menjadi node teks XML dengan nama yang ditentukan. Misalnya, setelan berikut:
<TextNodeName>age</TextNodeName>
mengonversi JSON ini:
{ "person": { "firstName": "John", "lastName": "Smith", "age": 25 } }
ke struktur XML ini:
<person> <firstName>John</firstName>25<lastName>Smith</lastName> </person>
Jika TextNodeName
tidak ditentukan, XML akan dihasilkan, menggunakan setelan default
untuk node teks:
<person> <firstName>John</firstName> <age>25</age> <lastName>Smith</lastName> </person>
Elemen <Options>/<NullValue>
Menunjukkan nilai null. Secara default, nilainya adalah NULL
.
Misalnya, setelan berikut:
<NullValue>I_AM_NULL</NullValue>Mengonversi objek JSON berikut:
{"person" : "I_AM_NULL"}
ke elemen XML berikut:
<person></person>
Jika tidak ada nilai (atau nilai selain I_AM_NULL
) yang ditentukan untuk nilai Null, payload yang sama akan dikonversi menjadi:
<person>I_AM_NULL</person>
Elemen <Options>/<InvalidCharsReplacement>
Untuk membantu menangani XML tidak valid yang dapat menyebabkan masalah dengan parser, setelan ini akan mengganti elemen JSON yang menghasilkan XML tidak valid dengan string. Misalnya, setelan berikut:
<InvalidCharsReplacement>_</InvalidCharsReplacement>
Mengonversi objek JSON ini
{ "First%%%Name": "John" }
ke struktur XML ini:
<First_Name>John<First_Name>
Catatan penggunaan
Dalam skenario mediasi umum, kebijakan JSON ke XML pada alur permintaan masuk sering kali dipasangkan dengan kebijakan XMLtoJSON pada alur respons keluar. Dengan menggabungkan kebijakan dengan cara ini, JSON API dapat diekspos untuk layanan yang secara native hanya mendukung XML.
Sering kali ada baiknya menerapkan JSON default (kosong) ke kebijakan XML dan secara berulang menambahkan elemen konfigurasi sesuai kebutuhan.
Untuk skenario ketika API digunakan oleh beragam aplikasi klien yang mungkin memerlukan JSON dan XML, format respons dapat ditetapkan secara dinamis dengan mengonfigurasi kebijakan JSON ke XML dan XML ke JSON agar dijalankan secara bersyarat. Lihat Variabel dan kondisi flow untuk mengetahui implementasi skenario ini.
Skema
Referensi error
Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan dan variabel kesalahan yang disetel oleh Edge saat kebijakan ini memicu error. Informasi ini penting untuk diketahui apakah Anda mengembangkan aturan kesalahan untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.
Error runtime
Error ini dapat terjadi saat kebijakan dieksekusi.
Kode kesalahan | Status HTTP | Penyebab | Perbaiki |
---|---|---|---|
steps.jsontoxml.ExecutionFailed |
500 | Payload input (JSON) kosong atau input (JSON) yang diteruskan ke kebijakan JSON ke XML tidak valid atau memiliki format yang salah. | build |
steps.jsontoxml.InCompatibleTypes |
500 | Error ini terjadi jika jenis variabel yang ditentukan dalam elemen <Source> dan
elemen <OutputVariable> tidak sama. Jenis variabel yang ada dalam elemen <Source> dan elemen <OutputVariable> harus cocok. Jenis yang valid adalah message dan string . |
build |
steps.jsontoxml.InvalidSourceType |
500 | Error ini terjadi jika jenis variabel yang digunakan untuk menetapkan elemen <Source>
tidak valid. Jenis variabel yang valid adalah message dan string . |
build |
steps.jsontoxml.OutputVariableIsNotAvailable |
500 | Error ini terjadi jika variabel yang ditentukan dalam elemen <Source> Kebijakan JSON ke
XML adalah string jenis dan elemen <OutputVariable> tidak ditentukan.
Elemen <OutputVariable> bersifat wajib jika variabel yang ditentukan dalam elemen <Source>
adalah string jenis. |
build |
steps.jsontoxml.SourceUnavailable |
500 |
Error ini terjadi jika variabel message
yang ditentukan dalam elemen <Source> dari kebijakan JSON ke XML adalah:
|
build |
Error saat deployment
Tidak ada.
Variabel kesalahan
Variabel ini ditetapkan saat terjadi error runtime. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.
Variabel | Dari mana | Contoh |
---|---|---|
fault.name="fault_name" |
fault_name adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan. | fault.name Matches "SourceUnavailable" |
jsontoxml.policy_name.failed |
policy_name adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan. | jsontoxml.JSON-to-XML-1.failed = true |
Contoh respons error
{ "fault": { "faultstring": "JSONToXML[JSON-to-XML-1]: Source xyz is not available", "detail": { "errorcode": "steps.json2xml.SourceUnavailable" } } }
Contoh aturan kesalahan
<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>
Topik terkait
- XML ke JSON: Kebijakan XML ke JSON
- Transformasi XSL: Kebijakan Transformasi XSL