Форматер JSON для запросов и ответов API
Форматируйте, проверяйте и проверяйте API JSON с редактированием в виде дерева, чтобы полезные данные стали читаемыми, прежде чем вы сможете их сравнить, повторно отправить или задокументировать.
Это руководство предназначено для отладки запросов и ответов, особенно если журналы содержат минифицированный JSON, вложенные ошибки или вставленный синтаксис Python dict.
Используйте это, когда
Полезная нагрузка API технически допустима, но слишком плотна для безопасного чтения, сравнения или редактирования.
Что проверить в первую очередь
Отформатируйте полезные данные, разверните древовидное представление и просканируйте ключи верхнего уровня, прежде чем приступить к редактированию значений.
Распространенная ошибка
Журналы и заметки часто содержат синтаксис Python dict. Живой инструмент восстанавливает этот формат, поэтому вы можете быстро его нормализовать.
Отформатируйте минимизированный ответ об успехе
Сначала распечатайте полезную нагрузку, чтобы изменения во вложенных ключах стали видимыми.
{"status":"ok","requestId":"req_123","data":{"id":42,"name":"launch"}}
Проверка вложенных полезных данных ошибок
Древовидное представление упрощает поиск кода, сообщения и деталей без прокрутки одной плотной строки.
{"error":{"code":"AUTH_EXPIRED","message":"Token expired","details":{"exp":1712732400}}}
Восстановить синтаксис Python dict
Вставьте полезную нагрузку точно так, как она появилась в журналах, затем нормализуйте ее перед отправкой или воспроизведением.
{'status': 'error', 'details': {'scope': 'read:users'}}
Очистите тело запроса перед повторной отправкой
Используйте форматтер, чтобы проверить тело запроса, прежде чем оно вернется в ваш API-клиент.
{"name":"launch","metadata":{"env":"staging","featureFlags":["beta"]}}
Древовидное представление работает быстрее, чем необработанный текст, когда вам нужно проверить вложение, сравнить ветки или отредактировать одно поле без потери контекста.
- Как только полезная нагрузка станет доступной для чтения, используйте средство проверки различий, чтобы сравнить старые и новые ответы.
Многие заметки об инцидентах и журналы оболочки содержат форматирование Python dict вместо строгого JSON. Живой инструмент восстанавливает эту структуру, поэтому вы можете ее нормализовать, а не переписывать вручную.
- Вернитесь к декодированию JWT, когда сама полезная нагрузка представляет собой набор утверждений токена, а не универсальное тело API.