Налагодження API

Як покроково налагоджувати JSON-відповідь API

Послідовний процес, що відокремлює транспортні помилки, синтаксис JSON і невідповідність контракту даних.

Те, що виглядає як пошкоджений JSON, може бути HTML-сторінкою помилки, відповіддю проксі або правильними даними неправильної форми. Перевіряйте відповідь пошарово.

Збережіть очищені від секретів сирі статус, заголовки й тіло. Передчасне форматування може приховати обрізання або точне місце помилки.

Перевірте HTTP до розбору JSON

Звірте статус, Content-Type, Content-Encoding і кодування. Відповідь 200 усе одно може містити сторінку входу, а корисна JSON-помилка — мати статус 400 чи 500.

Відтворіть запит через cURL і порівняйте метод, URL, параметри, тіло, автентифікацію та Accept із проблемним клієнтом.

Відокремте синтаксис від контракту

Якщо форматування не працює, шукайте зайві коми, неекрановані лапки, керівні символи, обрізані дані й сторонній текст навколо JSON.

Якщо JSON розбирається, перевірте обов’язкові поля, null, типи, enum і вкладені масиви за документацією або схемою.

Порівняйте з правильною відповіддю

Приберіть змінні ID і timestamps та порівняйте проблемний зразок із робочим. Структурні зміни важливіші за пробіли й порядок ключів.

Зафіксуйте найменший запит, що відтворює помилку, і рівень її появи — клієнт, застосунок, проксі, CDN чи зовнішній сервіс.

Чекліст налагодження відповіді API

  • Збережіть сирі статус, заголовки й тіло.
  • Звірте Content-Type та кодування з реальним вмістом.
  • Відтворіть запит поза проблемним клієнтом.
  • Перевіряйте синтаксис JSON окремо від схеми API.
  • Звірте типи, null, обов’язкові поля й форму масивів.
  • Видаліть токени й персональні дані перед поширенням прикладу.

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

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

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