JSON formatter и JSON validator са свързани, но не решават един и същ проблем. Formatting прави JSON по-лесен за четене. Validation проверява дали JSON може да бъде parsed. Преди да поставите snippet в docs, config поле, issue или support reply, може да ви трябва едното, другото или и двете.
JSON / YAML / TOML конверторът на Converty държи тези задачи заедно: validate input-а, format за review, minify когато compact output има значение и convert, когато следващата система очаква YAML или TOML.
Използвайте formatter, когато JSON е труден за четене
Formatting е въпрос на presentation. То добавя indentation и line breaks, така че structure да е по-лесна за inspection.
Използвайте formatting, когато:
- payload е minified в един ред
- nested objects са трудни за следване
- API example трябва да се покаже в documentation
- reviewers трябва бързо да сравнят fields
- support reply има нужда от readable snippet
Formatting не доказва, че example е semantically correct. То просто прави structure visible.
Използвайте validator, когато JSON може да е невалиден
Validation е въпрос на parseability. Тя хваща syntax problems като missing commas, unclosed strings, invalid quotation marks или broken nesting.
Използвайте validation, преди да поставите JSON в система, която ще отхвърли invalid input. Полезна е и преди споделяне на examples, защото invalid snippets губят reviewer time и правят documentation по-малко надеждна.
Използвайте и двете преди важни examples
Най-сигурният workflow е validation първо, formatting второ. Ако JSON не се parse-ва, поправете това, преди да мислите за presentation. След като е valid, format-нете го, така че хората да могат да го четат.
Тази последователност е особено полезна за API examples. За фокусиран API-sharing workflow прочетете Как да форматирате JSON, преди да споделите API пример.
Кога conversion влиза в картината
Понякога следващата система има нужда от YAML или TOML вместо JSON. Conversion е трета задача, отделна от formatting и validation. Тя променя syntax, като се опитва да запази data structure.
Не всяка structure се map-ва чисто към всеки format, затова compatibility warnings имат значение. Ако TOML output е недостъпен, прочетете Защо TOML изход е недостъпен за някои JSON или YAML входове.
Отворете JSON / YAML / TOML конвертора, когато трябва да validate, format, minify или convert structured data, преди да я поставите в следващия workflow.
