API та дані

Як debug JSON API responses

Відформатуйте response, перевірте HTTP status, validate schema і порівняйте payload changes перед змінами в application code.

API response bugs часто змішують дві проблеми: request відправив не те, що очікувалось, або response body не відповідає формі, яку очікує application.

Надійний workflow розділяє transport, syntax, schema і change detection, щоб знайти причину без здогадок.

Почніть із request

Якщо bug report містить copied cURL command, спочатку розберіть його. Перевірте method, URL, query parameters, headers, content type і body.

Неправильний Authorization header, missing content type, stale endpoint або змінений query parameter можуть дати valid JSON response, який все одно є неправильним.

Форматуйте і validate response

Pretty-print JSON, щоб nested objects, arrays, nulls і escaped strings було легше перевірити.

Потім validate response against JSON Schema, щоб знайти missing required fields, wrong types, changed enum values і unexpected nested shapes.

Порівняйте before/after payloads

Коли API змінюється після release, порівняйте old і new JSON side by side. Шукайте renamed fields, new wrappers, removed arrays, changed IDs і different status values.

Спочатку нормалізуйте formatting, щоб diff показував data changes, а не whitespace.

API JSON debugging checklist

  • Parse copied cURL request і перевірте method, URL, headers та body.
  • Перевірте HTTP status і content type перед body.
  • Format JSON response і видаліть private values перед sharing.
  • Validate payload against expected schema.
  • Diff old/new responses, якщо release або vendor change зламали behavior.

Пов’язані гайди

Дізнайся workflow за цим інструментом і що перевіряти далі.

Пов’язані інструменти