How to Format, Validate and Minify JSON

JSON has become the standard format for APIs, configuration files, logs, and data exchange. While its simplicity can be deceiving, small errors like a misplaced comma can cause significant issues in a lengthy document. A JSON formatter performs three essential tasks simultaneously: validating syntax, pretty-printing the document for human readability, and minifying it to save space.

Here's a breakdown of how each of these functions operates, along with a debugging workflow for when API responses or configuration files behave unexpectedly.

Validation is the first step taken by a formatter. It works by running a parser over the document. If the parser encounters any errors, it returns the precise error location, typically indicating the line and character where parsing failed. A reliable validator will be able to pinpoint the exact spot where the parsing process broke down, providing a crucial starting point for troubleshooting.

The second function of a JSON formatter is pretty-printing. This process involves adding indentation and placing one key-value pair on each line. It's important to note that the data within the document remains unchanged; only the formatting is altered. The purpose of pretty-printing is to enhance the document's readability without altering its information content. For example, a simple JSON object can be transformed from a single line to a more human-readable format, making it easier to spot errors or inconsistencies.

Minification is the third and final function of a JSON formatter. This process removes all insignificant whitespace, condensing the document down to a single line. The primary purpose of minification is to save space, making it ideal for sending payloads over a network or storing them in a build artifact. For instance, a JSON object can be compressed from a multi-line format to a more compact single-line format, significantly reducing its size without sacrificing any information.

In practice, you might encounter various issues when dealing with JSON. Common problems include trailing commas after the last item in an array or object, unquoted keys, single quotes around string values, comments, NaN (Not-a-Number) values, Infinity, undefined, and duplicate keys. These errors are often easy to overlook due to JSON's simple syntax, but they can lead to significant problems when processing JSON data.

When debugging JSON issues in API responses or configuration files, there's a recommended workflow to follow. First, capture the raw response exactly as received, ensuring to save it without making any edits. Next, validate the captured data using a JSON formatter. If the validation is successful, the issue is likely not with the syntax but with the structure or values within the document.

Once validated, pretty-print the JSON document to make the structure more visible. The added indentation and line breaks can make it easier to identify the fields your code expects. Carefully search the formatted document to locate these specific fields, which can often reveal mismatches in key names, such as discrepancies between snake_case and camelCase.

After identifying potential issues through pretty-printing, it's crucial to minify the document before pasting it into a bug report. Minifying the document to a single line can significantly reduce its size, making it more manageable and easier to share. Keep in mind that the raw copy of the JSON document should be kept separate from any edited versions.

This separation is essential because once you start making manual corrections to the document, you lose the original evidence of what the server actually sent. For debugging purposes, the formatting step should be viewed as a tool for visualizing structure, not for validating data types or field values. If the document validates successfully but still behaves incorrectly, further investigation into the types of the fields you rely on, and comparing the payload against the documented schema, is necessary.

SwiftTools, a collection of free, no-sign-up browser-based tools, includes a JSON Formatter that runs entirely in the browser. This ensures that sensitive payloads remain on your machine, offering a convenient and secure way to format, validate, and minify JSON data.