ЈСОН форматер и ЈСОН валидатор су повезани, али не решавају исти проблем. Форматирање чини ЈСОН лакшим за читање. Валидација проверава да ли се ЈСОН може рашчланити. Пре него што налепите исечак у документе, поље за конфигурацију, проблем или одговор подршке, можда ће вам требати један или обоје.
Цонверти-јев ЈСОН / ИАМЛ / ТОМЛ Цонвертер одржава те послове заједно: потврди унос, форматира га за преглед, минимизира га када је компактан излаз важан и конвертује га када следећи систем очекује ИАМЛ или ТОМЛ.
Користите форматер када је ЈСОН тешко читљив
Форматирање се односи на презентацију. Додаје увлачење и преломе линија тако да је структуру лакше прегледати.
Користите форматирање када:
- корисни терет се минимизира у једну линију
- угнежђене објекте је тешко пратити
- пример АПИ-ја треба да буде приказан у документацији
- рецензенти морају брзо да упореде поља
- за одговор подршке је потребан читљив исечак
Форматирање не доказује да је пример семантички исправан. То једноставно чини структуру видљивом.
Користите валидатор када је ЈСОН можда неважећи
Валидација се односи на рашчлањивање. Хвата синтаксне проблеме као што су недостајући зарези, незатворени низови, неважећи знаци навода или прекинуто угнежђење.
Користите проверу пре него што налепите ЈСОН у систем који ће одбити неважећи унос. Такође је корисно пре дељења примера јер неважећи исечци губе време прегледача и чине документацију мање поузданом.
Користите оба пре него што поделите важне примере
Најсигурнији ток посла је прво провера ваљаности, а затим форматирање. Ако се ЈСОН не анализира, поправите то пре него што се бринете о презентацији. Када постане валидан, форматирајте га тако да људи могу да га читају.
Ова секвенца је посебно корисна за примере АПИ-ја. За фокусиран ток посла дељења АПИ-ја, прочитајте Како форматирати ЈСОН пре дељења примера АПИ-ја.
Када конверзија уђе у слику
Понекад је следећем систему потребан ИАМЛ или ТОМЛ уместо ЈСОН. Конверзија је трећи посао, одвојен од форматирања и валидације. Мења синтаксу док покушава да сачува структуру података.
Није свака структура јасно мапирана у сваки формат, због чега су упозорења о компатибилности важна. Ако ТОМЛ излаз није доступан, прочитајте Зашто је ТОМЛ излаз недоступан за неке ЈСОН или ИАМЛ улазе.
Отворите ЈСОН / ИАМЛ / ТОМЛ Цонвертер када треба да потврдите, форматирате, минимизирате или конвертујете структуриране податке пре него што их налепите у следећи ток посла.
