リリース前、デバッグ時、回帰レビュー時にAPIレスポンスを比較する

ステージングのペイロードが本番環境と一致しなくなった場合、Postmanコレクションが異なるフィールドを返し始めた場合、リリース候補がネストされたオブジェクトを変更した場合、またはQAが生ログを1行ずつ読まずに回帰修正を検証する必要がある場合に、APIレスポンスを比較します。

API出力はフォーマット、ネスト、フィールド順序の面で頻繁に変化するため、プレーンテキスト比較よりも適しています。JSONを認識したレビューにより、実際の動作変更をより簡単に発見できます。

以前のレスポンスを左に、新しいレスポンスを右に貼り付け、両方のペイロードを正規化してから、構造上の変更をレビューします。その後、プルリクエストやリリースノートで動作変更について議論します。これにより、会話はAPIが実際に変更した内容に集中します。

レスポンスの形式が正しくない場合は、まずJSON Repairを実行してください。出力がJSONでなくなり、ドキュメントやエクスポートファイルになった場合は、信頼できる情報源に応じてText DiffまたはPDF Diffに切り替えてください。