API更新前後のJSONはどう比べる？項目の有無・型・nullの確認

API更新前後のJSONを比べるには、同じエンドポイントから同じ条件で取得した応答を2点用意し、項目の有無・値の型・配列内で項目が現れた割合を確認します。数値の1200と文字列の「1200」は型が異なります。nullは、項目が存在するときに取り得る値の一つです。

架空のJSONで確認する2つの差分

変更前

{"items":[{"price":1200,"note":null},{"price":1500,"note":"予約"}]}

変更後

{"items":[{"price":"1200"},{"price":1500,"note":"予約"}]}

priceは変更前の2件が数値で、変更後は数値と文字列が1件ずつです。noteの出現は2件中2件から2件中1件に変わりました。変更前の1件目には値がnullのnoteがあり、変更後の1件目ではnoteという項目自体がありません。

比較するJSONのそろえ方

取得先、絞り込み条件、ページ番号をそろえ、ファイル名で前後が分かるようにします。認証情報や個人情報を除き、値を置き換えるときは数値には数値、文字列には文字列のダミーを使います。確認したい項目の有無やnullも保ちます。

依頼できる作業と納品物

「API応答のJSON構造を比較します」では、1エンドポイントの変更前後のJSONを各1点お預かりし、HTMLレポートと項目パス別の差分CSVを納品します。基本料金は5,000円です。UTF-8で各64 KiB・8階層・3,000ノードまで。購入後、必要資料がそろってから3日を目安にお届けします。購入前の見積り相談では取得条件とファイルの形式・容量をお知らせください。

よくある質問

Q. 片方が空配列でも、配列の要素を比べられますか？

A. 空配列の応答からは要素内の項目や型を確認できません。空だった条件を記録し、必要に応じて要素を含むサンプルを用意します。

Q. 比較結果から連携先が動くか分かりますか？

A. 型や項目の差分から、連携先で再確認する箇所を絞れます。実際の動作は連携先の環境でご確認ください。

API応答の比較とDocker Composeの設定点検をまとめて確認したい方は、こちらの記事をご覧ください。

API応答とDocker Composeの点検サービスを出品しました