En JSON-formaterare och en JSON-validator är relaterade, men de löser inte samma problem. Formatering gör JSON lättare att läsa. Validering kontrollerar om JSON kan tolkas. Innan du klistrar in ett utdrag i dokument, ett konfigurationsfält, ett problem eller ett supportsvar kan du behöva en eller båda.
Convertys JSON / YAML / TOML Converter håller ihop dessa jobb: validera indata, formatera det för granskning, förminska det när kompakt utdata är viktigt och konvertera det när nästa system förväntar sig YAML eller TOML.
Använd en formatterare när JSON är svår att läsa
Formatering handlar om presentation. Den lägger till indrag och radbrytningar så att strukturen är lättare att inspektera.
Använd formatering när:
- en nyttolast minimeras till en rad
- kapslade objekt är svåra att följa
- ett API-exempel måste visas i dokumentationen
- granskare måste jämföra fält snabbt
- ett supportsvar behöver ett läsbart utdrag
Formatering bevisar inte att exemplet är semantiskt korrekt. Det gör helt enkelt strukturen synlig.
Använd en validator när JSON kan vara ogiltig
Validering handlar om tolkbarhet. Det fångar syntaxproblem som saknade kommatecken, oslutna strängar, ogiltiga citattecken eller trasig kapsling.
Använd validering innan du klistrar in JSON i ett system som kommer att avvisa ogiltig inmatning. Det är också användbart innan du delar exempel eftersom ogiltiga utdrag slösar bort granskarens tid och gör dokumentationen mindre pålitlig.
Använd båda innan du delar viktiga exempel
Det säkraste arbetsflödet är validering först, formatering sedan. Om JSON inte tolkar, fixa det innan du oroar dig för presentationen. När den är giltig, formatera den så att människor kan läsa den.
Denna sekvens är särskilt användbar för API-exempel. För ett fokuserat arbetsflöde för API-delning, läs Hur man formaterar JSON innan du delar ett API-exempel.
När konvertering kommer in i bilden
Ibland behöver nästa system YAML eller TOML istället för JSON. Konvertering är ett tredje jobb, separat från formatering och validering. Det ändrar syntaxen samtidigt som man försöker bevara datastrukturen.
Inte varje struktur mappar rent till varje format, varför kompatibilitetsvarningar är viktiga. Om TOML-utdata inte är tillgängligt, läs Why TOML Output Is Unavailable for Some JSON- eller YAML-ingångar.
Öppna JSON / YAML / TOML Converter när du behöver validera, formatera, förminska eller konvertera strukturerad data innan du klistrar in den i nästa arbetsflöde.
