A comunicação entre APIs necessita de cuidado em relação à codificações e caracteres que são enviados, pois estes podem impactar no envio e recepção de arquivos. O mesmo acontece com a transmissão de XML, precisando ter alguns caracteres escapados para evitar problemas no carregamento das informações.

Neste artigo mostraremos como formatar um XML usando o Notepad++ para que seja possível remover esses tratamentos e poder ter um arquivo XML visualmente formatado.

Instalar o notepad++

Primeiramente precisamos ter esta ferramenta instalada em nossa máquina, então acesse o site https://notepad-plus-plus.org/downloads/ e realize o download da versão mais recente. Após isto instale a aplicação, normalmente "next, next, finish" já é o suficiente.

Adicionar Plugin

Após instalar e executar o aplicativo, navegue até a aba "Plugins" e selecione "Gerenciador de plugins". Depois, pesquise por "xml tools", marque a checkbox deste plugin e depois clique em "instalar".

Caso quando estiver fazendo este tutorial este Plugin não esteja mais disponível, pode usar outro, pois a lógica será a mesma.

Formatando um XML

Comumente os caracteres "<" e ">" são trocados pelo conjunto de caracteres "&lt;" e "&gt;", então precisaremos usar um recurso do plugin para realizar esta conversão.

Abra o arquivo XML que precisa ser formatado no notepad++, selecione todo conteúdo do arquivo, navegue até a aba "Plugins", depois navegue até o plugin que foi instalado, neste caso o XML Tools e utilize a opção de "desescapar" caracteres codificados:

Por vezes é necessário realizar este passo mais de uma vez, devido os níveis e a quantidade de codificações que existem no texto. O resultado final deve estar assim, sendo possível visualizar os caracteres "<" e ">":

O XML já está quase formatado, mais ainda está linearizado, então precisamos "abrir" o texto de forma vertical, para isso usaremos a opção "Pretty print" do XML Tools:

O resultado deverá ser este aqui:

Agora, para finalizar, vamos mudar a linguagem do documento para "XML":

O resultado será este:

Salvando o arquivo como um XML válido

Existem outras informações no XML que não fazem parte do conteúdo e serve apenas para sinalizar codificações e informações técnicas para o sistema que estará recepcionando o arquivo, então ao tentar salvar o documento com a extensão ".xml" o notepad++ irá apontar estas informações que não são válidas para o arquivo XML:

Então remova esta declaração para que você possa salvar o documento como um XML válido:

O que é CDATA

Em alguns casos você perceberá que o arquivo contém um trecho "<![CDATA[", este "CDATA" é uma sigla em inglês para "Dados de caracteres". Ela serve para indicar que tudo que estiver dentro desse bloco deverá ser interpretado como texto comum. Isso ajuda a evitar que caracteres de XML incorporem em páginas HTML ou dificultem a transmissão entre APIs.
Esta marcação sempre inicia com "<![CDATA[" e finaliza com "]]>". Caso veja estas marcações, remova para que seja possível aplicar as formatações de XML usando o notepad++

Em anexo há um arquivo XML de exemplo para que você possa praticar.