What is JSON?
JSON is a lightweight text-based data format that is easy for humans to read and write, and easy for machines to parse and generate. It was derived from JavaScript but is completely language-independent — every major programming language has built-in JSON support.
A JSON document is built from two structures: • Objects — a collection of key-value pairs enclosed in curly braces {} • Arrays — an ordered list of values enclosed in square brackets []
Here is a simple JSON example:
{ "name": "Neeraj Bansal", "age": 30, "skills": ["React", "Node.js", "Python"], "address": { "city": "Meerut", "country": "India" } }
JSON supports six data types: strings (in double quotes), numbers, booleans (true/false), null, objects and arrays.
Why JSON Formatting Matters
Raw JSON from an API or database often comes as a single compressed line — called "minified" JSON. While this reduces file size for transmission, it is nearly impossible to read or debug.
Formatted (or "pretty-printed") JSON adds proper indentation and line breaks so the structure is immediately visible. Consider the difference:
Minified: {"name":"Neeraj","skills":["React","Node.js"],"active":true}
Formatted: { "name": "Neeraj", "skills": [ "React", "Node.js" ], "active": true }
The formatted version makes it instantly clear which keys exist, how deeply nested the data is, and where errors might be hiding. This is especially important when working with API responses that have 50+ fields nested several levels deep.
The Most Common JSON Errors
JSON has strict syntax rules. Even a single character mistake breaks the entire document. These are the errors developers encounter most often:
- 1Trailing commas — JSON does not allow a comma after the last item in an object or array. JavaScript does (in modern syntax), which is why this trips up so many developers.
- 1Single quotes — JSON requires double quotes for all string keys and values. Single quotes are not valid JSON.
- 1Unquoted keys — Unlike JavaScript objects, JSON requires every key to be a string in double quotes. {name: "value"} is not valid JSON.
- 1Comments — JSON does not support comments of any kind. // and /* */ are not allowed.
- 1Undefined values — JSON does not support JavaScript's undefined type. Only string, number, boolean, null, object and array are valid.
- 1NaN and Infinity — These JavaScript values are not valid JSON numbers.
A good JSON formatter will identify exactly which line contains the error and what type of error it is, saving hours of debugging time.
JSON vs Other Data Formats
JSON is not the only data interchange format, but it is the most popular by a wide margin. How does it compare?
JSON vs XML: XML was the dominant format before JSON. XML uses verbose tags like <name>value</name>, making documents much larger than equivalent JSON. JSON is typically 30–40% smaller. JSON is also easier to parse in JavaScript since it maps directly to JavaScript objects.
JSON vs YAML: YAML is more human-readable but is error-prone due to indentation sensitivity and complex edge cases. JSON is stricter and therefore more predictable for machine-to-machine communication. YAML is preferred for configuration files; JSON for APIs.
JSON vs CSV: CSV is great for tabular data (rows and columns) but cannot represent nested data structures. JSON handles nested objects and arrays naturally.
For REST APIs, JSON is the undisputed standard. For configuration files (Docker, Kubernetes, GitHub Actions), YAML is more common. For data storage and transmission between services, JSON is the first choice.
Best Practices for Working with JSON
Follow these practices to write clean, maintainable JSON:
Use consistent naming conventions — camelCase (firstName) is most common in JavaScript APIs, while snake_case (first_name) is common in Python and Ruby APIs. Pick one and stick to it across your entire API.
Keep nesting shallow — deeply nested JSON is hard to read and query. If you find yourself going more than 3–4 levels deep, consider flattening the structure.
Use ISO 8601 for dates — store dates as strings in ISO 8601 format (2026-07-16T10:30:00Z) rather than Unix timestamps. They are human-readable and universally understood.
Validate before storing — always validate JSON input from external sources. Never trust that incoming JSON is valid or safe without parsing it through a proper JSON parser.
Use a formatter for debugging — when an API call returns unexpected data, run the response through a JSON formatter immediately. Formatted JSON reveals structural problems in seconds that would take minutes to spot in raw form.