Convertir XML a JSON: APIs públicas que aún usan XML

Contenido
Es posible que hayas abierto la documentación de una API del portal de datos abiertos o de un sistema interno antiguo y te hayas encontrado con que el ejemplo de respuesta no está en JSON, sino en XML. Hoy casi todas las API nuevas usan JSON, así que cuesta entender por qué estos sistemas se aferran al XML. Este artículo explica ese motivo y cómo convertir el XML que recibes en un JSON más fácil de manejar.
Resumen ① Las instituciones públicas y los sistemas antiguos usan XML porque siguen manteniendo estructuras diseñadas cuando XML era el estándar, como SOAP o el marco estándar de gobierno electrónico. ② Los atributos de XML se representan en JSON con una clave «@nombreAtributo», y el texto que acompaña a una etiqueta se guarda por separado en la clave «#text». ③ Si un elemento con el mismo nombre aparece una sola vez, se convierte en un objeto; si aparece dos o más veces, pasa a ser un array. Por eso, a simple vista cuesta saber cuántos valores hay.
¿Por qué algunas API siguen respondiendo en XML?
Hubo una época en la que XML era el estándar de facto para las API web. A principios y mediados de la década de 2000, los servicios web basados en SOAP eran el mecanismo de comunicación habitual en sistemas empresariales y de instituciones públicas, y muchos de los sistemas diseñados entonces siguen usando esa misma estructura.
En Corea, buena parte de los sistemas de las instituciones públicas se construyó sobre el marco estándar de gobierno electrónico. Ese estándar se consolidó cuando XML y SOAP eran la corriente principal; por eso, incluso después de la popularización de JSON, en muchos casos se mantuvo la estructura de respuesta XML en lugar de rehacer los sistemas existentes.
Las API abiertas que se obtienen del portal de datos públicos funcionan de forma parecida. Todavía quedan API que devuelven XML por defecto si no indicas el formato de respuesta en los parámetros de la solicitud, y a menudo JSON solo se obtiene añadiendo un parámetro adicional.
Salvo que se rediseñe por completo el sistema, no es fácil cambiar únicamente el formato de respuesta. Por eso, la respuesta práctica suele estar del lado de quien consume la API: recibir XML y convertirlo a JSON.
Cómo convertir XML a JSON: empieza por los atributos y las etiquetas repetidas
Las reglas que se aplican al pasar XML a JSON están definidas. Veámoslo con un documento XML que contiene información de un libro. Supongamos que el elemento superior es book y tiene el atributo id=1, y que dentro hay un elemento title, un elemento price y dos elementos tags.
Las 3 reglas de conversión de XML a JSON
Regla 1 — el nombre del elemento se convierte en la clave tal cual. En elementos sin hijos, como title o price, el nombre pasa a ser la clave y el texto que contienen se convierte en el valor.
Regla 2 — los atributos no se mezclan con el valor original, sino que se separan en una clave «@nombreAtributo». El atributo id de book se guarda en la clave «@id»; si el elemento también tiene texto, ese texto va en una clave «#text» aparte.
Regla 3 — si varios elementos con el mismo nombre aparecen como hermanos, se convierten en un array. Como tags aparece dos veces, su valor será un array con «SEO» y «blog»; si hubiera aparecido una sola vez, no sería un array, sino un único valor de cadena.
Al aplicar las tres reglas tal cual, se obtiene un JSON en el que la clave book contiene «@id» con «1», title con «El manual de la automatización», price con «18000» y tags con un array que contiene «SEO» y «blog».
Cuando quieres volver de JSON a XML
Los objetos se anidan como elementos hijos y los arrays repiten el mismo nombre de elemento tantas veces como valores haya. Aquí hace falta un nombre para el elemento raíz que envuelva todo el JSON. Aunque el JSON tenga una sola clave, como book, esa clave no se convierte directamente en la etiqueta raíz: el resultado aparece envuelto una vez más bajo el nombre de elemento raíz que se indique.
Las reglas no son difíciles, pero cuando hay elementos anidados y se mezclan atributos y elementos repetidos, es fácil pasar algo por alto al hacerlo a mano y no saber dónde debe aparecer un array. Además, cuanto más largo es el original, más difícil resulta contar a simple vista cuántas veces aparece un mismo elemento.
Compruébalo con nuestro Conversor JSON ↔ XML. Elige la dirección de la conversión en las pestañas y pega el original; verás de inmediato el resultado con las reglas aplicadas, incluido el tratamiento de atributos y elementos repetidos.
Gratis · Sin registro · Convierte JSON ↔ XML directamente en el navegador

Puntos que suelen causar problemas
| Situación | Por qué ocurre |
|---|---|
| Un elemento lleva atributos | Los atributos no se mezclan con el valor de texto, sino que se separan en una clave «@nombreAtributo» |
| Un mismo elemento aparece una vez o varias | Si aparece una vez, es un valor único; si aparece dos o más veces, pasa a ser un array, y el código que lo procesa debe tratarlo de forma distinta |
| Al convertir JSON a XML | La clave superior del original no se convierte directamente en etiqueta, sino que queda envuelta una vez más bajo el nombre de elemento raíz indicado |
| Objetos o arrays con valores vacíos | Se representan en forma de etiqueta autocerrada, solo con el nombre y sin etiqueta de cierre, lo que puede hacer dudar de si el valor está vacío |
En la tabla, todas las situaciones se reducen a dos preguntas: «¿tiene atributos?» y «¿se repite el mismo elemento?». Si empiezas por comprobar estas dos cosas cuando veas XML, será más fácil predecir el resultado de la conversión.
En resumen
Las instituciones públicas y los sistemas antiguos siguen respondiendo en XML porque mantienen estructuras diseñadas cuando XML era el estándar, como SOAP o el marco estándar de gobierno electrónico. Salvo que se reescriba el sistema desde cero, lo práctico es que quien hace la solicitud reciba XML y lo convierta a JSON.
Las dos reglas clave de la conversión son separar los atributos en una clave «@nombreAtributo» y agrupar los elementos repetidos en un array. Con estas reglas puedes hacer la conversión a mano, pero cuantos más elementos haya, más engorroso resulta contar a simple vista si se repiten.
Gratis · Sin registro · Convierte JSON ↔ XML directamente en el navegador
Preguntas frecuentes
¿Cómo se representan los atributos de XML en JSON?
Los atributos se guardan en una clave aparte con la forma «@nombreAtributo» para distinguirlos del valor de texto. Si un elemento tiene atributos y también texto, el texto va en una clave «#text» separada, de modo que atributos y texto no terminan mezclados en un mismo valor.
Si una misma etiqueta aparece varias veces, ¿siempre se convierte en un array?
Si un elemento con el mismo nombre aparece dos o más veces como hermano, se convierte en un array. Si aparece una sola vez, se trata como un valor único (una cadena o un objeto), así que en el código conviene comprobar primero si es un array o no antes de manejarlo.
¿Por qué hace falta un nombre de elemento raíz al convertir JSON a XML?
Un documento XML debe comenzar con un único elemento raíz. Aunque el JSON original tenga una sola clave, esa clave no se convierte directamente en la etiqueta superior: el nombre de elemento raíz indicado pasa a ser la etiqueta exterior que lo envuelve, y la clave original queda dentro como elemento hijo.
Este artículo está adaptado de nuestro original en coreano. Leer el original en coreano