XMLをJSONに変換する方法|APIが今もXMLを使う理由

公開更新ツールJSON ↔ XML 変換

目次
  1. なぜ今でもXMLで応答するAPIがあるのか
  2. XMLをJSONに変換する方法: まずは属性と繰り返しタグを整理する
  3. つまずきやすいポイント
  4. まとめ
  5. よくある質問

公共データポータルや古い社内システムのAPIドキュメントを開いたら、レスポンス例がJSONではなくXMLで書かれていて戸惑った、という経験はないでしょうか。最近新しく作られるAPIはほとんどがJSONを使っているのに、なぜこうしたシステムだけXMLにこだわるのか、不思議に思う方も多いはずです。この記事では、その理由と、受け取ったXMLを扱いやすいJSONに変換する方法をまとめます。

要約 ① 公共機関や旧バージョンのシステムがXMLを使っているのは、SOAPや電子政府標準フレームワークのように、XMLが標準だった時代に設計された構造をそのまま使い続けているためです ② XMLの属性(attribute)はJSONでは「@属性名」キーに、タグと並んでいたテキストは「#text」キーに、それぞれ分けて表現されます ③ 同じ名前の要素が1回だけ出てくる場合はオブジェクト、2回以上出てくる場合は配列に変わるため、見た目だけでは値がいくつあるのか判断しづらくなります

なぜ今でもXMLで応答するAPIがあるのか

XMLがWebAPIの事実上の標準だった時代がありました。2000年代前半から中盤にかけては、SOAPベースのWebサービスが企業や公共機関のシステムの基本的な通信方式でした。このころに設計されたシステムは、今でもその構造のまま使われています。

韓国の公共機関のシステムの多くは、電子政府標準フレームワークをベースに作られています。この標準が定着したのはXMLやSOAPが主流だった時期にあたるため、その後JSONが広まってからも、既存のシステムを作り直すのではなく、XMLの応答構造をそのまま維持して運用しているケースが少なくありません。

公共データポータルで提供されているオープンAPIも同様です。リクエストパラメータでレスポンス形式を指定しないと、XMLをデフォルトで返すAPIが今も残っており、JSONで受け取るには別のパラメータを追加する必要がある場合もよくあります。

システムを根本から設計し直さない限り、レスポンス形式だけを切り替えるのは簡単ではありません。そのため、リクエストする側でXMLを受け取り、自分でJSONに変換して使うのが現実的な対応になります。

XMLをJSONに変換する方法: まずは属性と繰り返しタグを整理する

XMLをJSONに置き換えるときに適用されるルールは決まっています。ここでは、書籍情報を持つXMLドキュメントを例に説明します。最上位にbookという要素があり、id=1という属性が付いています。その中にtitle要素とprice要素が1つずつ、tags要素が2つ入っているものとします。

XML → JSON 変換ルール3つ

ルール1 — 要素名はそのままキーになります。titleやpriceのように子を持たない要素は、名前をキー、中のテキストを値として、そのまま移します。

ルール2 — 属性は元の値と混ざらず、「@属性名」キーとして別に分けられます。bookのid属性は「@id」キーに入り、テキストを併せ持つ要素の場合は、そのテキストが「#text」キーに別途入ります。

ルール3 — 同じ名前の要素が兄弟として複数回出てくると、配列になります。tags要素は2回出てくるので、値はSEOとブログを含む配列になります。1回だけだった場合は、配列ではなく文字列の単一の値になります。

この3つのルールをそのまま適用すると、bookキーの中に、@idは「1」、titleは「자동화의 정석」、priceは「18000」、tagsはSEOとブログを含む配列、という内容のJSONができあがります。

JSON → XMLに戻すとき

オブジェクトは子要素として入れ子になり、配列は同じ名前の要素を値の数だけ繰り返して並べます。このとき、JSON全体を包む最上位の要素名が必要になります。bookのようにキーが1つだけの場合でも、そのキーがそのまま最上位タグになるわけではなく、指定したルート要素名の下にもう一段包まれた形で出力されます。

ルール自体は難しくありませんが、要素が入れ子になり、属性や繰り返し要素が混ざってくると、手作業で変換するうちに、どこで配列にすべきかを見落としがちです。特に、同じ要素が何回出てくるかは、元データが長くなるほど目で数えるのが大変になります。

Dynamic Labsのツールで確認する。 変換方向をタブで選んで元データを貼り付けると、属性や繰り返し要素の処理までルールどおりに適用された結果をすぐに確認できます。

JSON ↔ XML 変換

無料・登録不要・ブラウザですぐにJSON ↔ XML変換

つまずきやすいポイント

状況理由
要素に属性が付いている属性はテキストの値と混ざらず、「@属性名」キーとして別に分けられます
同じ要素が1回だけの場合と複数回の場合1回なら単一の値、2回以上なら配列に変わるため、後続の処理コードも変える必要があります
JSONをXMLに変換するとき元の最上位キーがそのままタグになるのではなく、指定したルート要素名の下にもう一段包まれます
値が空のオブジェクト・配列閉じタグを使わず名前だけを書く自己閉じタグの形で表示されるため、空の値なのか紛らわしいことがあります

表にまとめた状況は、結局のところ「属性があるか」と「同じ要素が繰り返されるか」の2点に絞られます。XMLを見るときにこの2点から確認しておくと、変換結果を予測しやすくなります。

まとめ

公共機関や旧バージョンのシステムが今もXMLで応答しているのは、SOAPや電子政府標準フレームワークのように、XMLが標準だった時代に設計された構造をそのまま維持しているためです。システム自体を作り直さない限り、リクエストする側でXMLを受け取ってJSONに変換して使うほうが現実的です。

変換ルールの要点は、属性を「@属性名」キーとして分けることと、繰り返される要素を配列にまとめることの2つです。このルールさえ押さえておけば手作業でも変換できますが、要素が増えるほど、繰り返しの有無を目で数えるのは面倒になります。

JSON ↔ XML 変換

無料・登録不要・ブラウザですぐにJSON ↔ XML変換

よくある質問

XMLの属性はJSONではどのように表されますか?

属性は、元のテキスト値と区別するために「@属性名」という形の別のキーとして入ります。属性とテキストを併せ持つ要素の場合は、テキストが「#text」キーに別途入るため、属性とテキストが1つの値に混ざることはありません。

同じタグが複数回出てきたら、必ず配列になりますか?

同じ名前の要素が兄弟として2回以上出てくると、配列になります。1回だけの場合は配列ではなく、単一の値(文字列またはオブジェクト)として扱われます。そのため、コードでこの値を扱うときは、まず配列かどうかを確認する必要があります。

JSONをXMLに変換するとき、なぜルート要素名が必要なのですか?

XMLドキュメントは、1つの最上位要素から始まる必要があります。元のJSONにキーが1つしかない場合でも、そのキーがそのまま最上位タグになるわけではありません。指定したルート要素名が外側を包むタグとなり、元のキーはその中の子要素として入ります。

この記事は韓国語の原文をもとに作成しています。 韓国語の原文を読む

関連記事

  1. CSVの予定表をカレンダーに一括登録|行が抜ける理由と対策複数の予定を.icsファイルにまとめてカレンダーへ一括登録する仕組みと、列名や日付形式が合わず行が通知なく抜け落ちる条件を、実際の動作に沿って解説します。
  2. CSVアップロード失敗は列の順序と名前を確認CSVを他のプログラムにアップロードしたときに値がずれる・拒否される原因を、列の順序とヘッダー名の照合方法から解説。目に見えない空白の点検方法もまとめました。
  3. CSV列順の並び替えで列数が違う行はどうなるかCSVの列順を並び替えると、行ごとの列数がヘッダーと違う場合に値がどこへ入りどこで切られるかを解説。並び替え前に列数を数式で確認する方法も紹介します。
  4. CSV重複削除の基準 行全体と特定の列で結果は変わる行全体が同じときだけ重複とみなすか、メールアドレスなど特定の列が同じなら重複とみなすかで、削除される行は変わります。基準を狭くした場合と広くした場合の失敗例を、表を使って説明します。
  5. CSVのエクセル変換で先頭0が消える原因と対処法CSVをExcelで開くと郵便番号の先頭0が消えたり、長い数字が1.23457E+12のような指数表記になる理由を解説。列の書式を文字列に指定して取り込めば元の値が保てること、変換ツールでそのままxlsxにできることも説明します。
  6. CSVがExcelで1列にまとまる原因と区切り文字の直し方JSONをCSVに変換したファイルがExcelでA列1つにまとまる原因を、OSのリスト区切り記号の設定から説明し、セミコロン区切りで先に作っておく回避方法をまとめます。

関連ツール