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