json-to-xml

Use a política json-to-xml para converter a carga útil de contexto de sua API do formato JavaScript Object Notation (JSON) para o formato extensible markup language (XML).

Suporte de gateway

Tabela 1. Tabela que mostra quais gateways suportam esta política e a versão correspondente da política
Gateway Versão da política
DataPower® Gateway (v5 compatible) 1.0.0
DataPower API Gateway 2.0.0

Este tópico descreve como configurar a política na sua fonte do ` OpenAPI `; para obter detalhes sobre como configurar a política na interface de usuário do assembly, consulte JSON para XML.

Sobre

A política json-to-xml tem a seguinte estrutura:
- json-to-xml:
   version: version
   title: Title
   description: Description
Nota: se você estiver usando o DataPower API Gateway, a entrada para a política json-to-xml deverá ser analisada. Uma maneira de produzir dados analisados é usar uma política parse antes de uma política json-to-xml em seu fluxo de conjuntos, que fornece controle explícito da ação de análise.

Propriedades

A tabela a seguir descreve as propriedades de política:
Tabela 2. Propriedades da política
Propriedade Obrigatório Descrição Tipo de dados
version True O número de versão da política sequência
title True O título da política. sequência
description Não Uma descrição da política. sequência
DataPower API Gateway
onlyinput Não A mensagem de entrada para converter. Especifique o nome de uma variável no contexto da API. variableName.body, a carga útil da mensagem, representa a entrada JSON para converter. O valor padrão da variável é message e message.body é a entrada padrão. sequência
DataPower API Gateway
onlyoutput Não A mensagem de saída para armazenar o resultado de conversão. Especifique o nome de uma variável no contexto da API. variableName.body representa o resultado da conversão do formato JSON para XML. Quando a mensagem de entrada especificada for a mensagem padrão, a saída padrão será message.body. Caso contrário, quando a mensagem de entrada for a variável my-message-variable, por exemplo, a saída padrão for my-message-variable.body.

A variável não pode ser nenhuma somente leitura no contexto da API.

sequência
DataPower API Gateway
onlyconversionType Não O tipo de conversão que determina o formato de destino da saída. As opções a seguir estão disponíveis:
  • Nenhum: não ocorre a conversão da saída.
  • badgerFish: a convenção BadgerFish é usada para determinar o formato de conversão de destino da saída.
sequência
root-element-name True O nome do elemento raiz do documento XML resultante. Esta propriedade é usada apenas se o documento JSON de entrada não for hierárquico e tiver mais de uma propriedade de nível superior ou se a propriedade always-output-root-element estiver configurada como true.
always-output-root-element True Selecione essa propriedade como true sempre que quiser que a política gere o elemento raiz, mesmo que ela não seja necessária para que o documento documento XML fique bem formado. booleano
unnamed-element-name Não O nome do elemento XML a ser usado para elementos de matriz JSON. sequência

Exemplo

A seguir está um exemplo de uma política json-to-xml:
- json-to-xml:
   version: 1.0.0
   title: JSON to XML transform
   description: Transforms JSON message body to XML format