Формат JSON і засіб перевірки JSON пов’язані, але вони не вирішують ту саму проблему. Форматування полегшує читання JSON. Перевірка перевіряє, чи можна проаналізувати JSON. Перш ніж вставити фрагмент у документи, поле конфігурації, проблему чи відповідь служби підтримки, вам може знадобитися одне або обидва.
Converty JSON/YAML/TOML Converter зберігає ці завдання разом: перевіряйте вхідні дані, форматуйте їх для перегляду, мінімізуйте їх, коли компактний вихід має значення, і конвертуйте їх, коли наступна система очікує YAML або TOML.
Використовуйте форматувальник, коли JSON важко читати
Форматування стосується презентації. Він додає відступи та розриви рядків, тому структуру легше перевіряти.
Використовуйте форматування, коли:
- корисне навантаження зведено в один рядок
- за вкладеними об'єктами важко стежити
- приклад API має бути показаний у документації
- рецензентам потрібно швидко порівнювати поля
- для відповіді служби підтримки потрібен читабельний фрагмент
Форматування не підтверджує семантично правильний приклад. Це просто робить структуру видимою.
Використовуйте валідатор, якщо JSON може бути недійсним
Валідація стосується синтаксичного аналізу. Він виявляє синтаксичні проблеми, такі як відсутні коми, незакриті рядки, недійсні лапки або пошкоджене вкладення.
Використовуйте перевірку, перш ніж вставляти JSON у систему, яка відхилятиме недійсні введення. Це також корисно перед тим, як ділитися прикладами, оскільки недійсні фрагменти витрачають час рецензента та роблять документацію менш надійною.
Використовуйте обидва, перш ніж ділитися важливими прикладами
Найбезпечнішим робочим процесом є спочатку перевірка, а потім форматування. Якщо JSON не аналізується, виправте це, перш ніж турбуватися про презентацію. Коли він стане дійсним, відформатуйте його, щоб люди могли його прочитати.
Ця послідовність особливо корисна для прикладів API. Щоб отримати докладніші відомості про робочий процес спільного використання API, прочитайте Приклад форматування JSON перед наданням спільного доступу до API.
Коли конверсія з'являється в картині
Іноді наступній системі потрібен YAML або TOML замість JSON. Перетворення — це третя робота, окрема від форматування та перевірки. Він змінює синтаксис, намагаючись зберегти структуру даних.
Не кожна структура точно відповідає кожному формату, тому попередження про сумісність важливі. Якщо вивід TOML недоступний, прочитайте Чому вивід TOML недоступний для деяких вхідних даних JSON або YAML.
Відкрийте JSON / YAML / TOML Converter, якщо вам потрібно перевірити, відформатувати, зменшити або конвертувати структуровані дані перед вставленням їх у наступний робочий процес.
