JSON

JSON (JavaScript Object Notation, pronounced or ) is an open standard file format and data interchange format that uses human-readable text to store and transmit data objects consisting of name–value pairs and arrays (or other serializable values). It is a commonly used data format with diverse uses in electronic data interchange, including that of web applications with servers.

JSON is a programming language-independent data format. It was derived from JavaScript, but many modern programming languages include code to generate and parse JSON-format data. JSON filenames use the extension <code>.json</code>.

Douglas Crockford originally specified the JSON format in the early 2000s. They and Chip Morningstar sent the first JSON message in April 2001.

Naming and pronunciation

The 2017 international standard (ECMA-404 and ISO/IEC 21778:2017) specifies that "JSON" is "pronounced , as in 'Jason and The Argonauts. The first (2013) edition of ECMA-404 did not address the pronunciation.

Standards

After RFC 4627 had been available as its "informational" specification since 2006, JSON was first standardized in 2013, as ECMA-404. The ECMA and ISO/IEC standards describe only the allowed syntax, whereas the RFC covers some security and interoperability considerations.

History

thumb|Douglas Crockford at the Yahoo Building (2007)

JSON grew out of a need for a real-time server-to-browser session communication protocol without using browser plugins such as Flash or Java applets, the dominant methods used in the early 2000s.

Crockford first specified and popularized the JSON format. website was launched in 2001. In December 2005, Yahoo! began offering some of its Web services in JSON.

A precursor to the JSON libraries was used in a children's digital asset trading game project named Cartoon Orbit at Communities.com which used a browser side plug-in with a proprietary messaging format to manipulate DHTML elements. Upon discovery of early Ajax capabilities, digiGroups, Noosh, and others used frames to pass information into the user browsers' visual field without refreshing a Web application's visual context, realizing real-time rich Web applications using only the standard HTTP, HTML, and JavaScript capabilities of Netscape 4.0.5+ and Internet Explorer 5+. Crockford then found that JavaScript could be used as an object-based messaging format for such a system. The system was sold to Sun Microsystems, Amazon.com, and EDS.

JSON was based on a subset of the JavaScript scripting language (specifically, Standard ECMA-262 3rd Edition—December 1999) and is commonly used with JavaScript, but it is a language-independent data format. Code for parsing and generating JSON data is readily available in many programming languages. JSON's website lists JSON libraries by language.

In October 2013, Ecma International published the first edition of its JSON standard ECMA-404. That same year, used ECMA-404 as a reference. In 2014, became the main reference for JSON's Internet uses, superseding and (but preserving ECMA-262 and ECMA-404 as main references). In November 2017, ISO/IEC JTC 1/SC 22 published ISO/IEC 21778:2017

Syntax

The following example shows a possible JSON representation describing a person.

{

"first_name": "John",

"last_name": "Smith",

"is_alive": true,

"age": 27,

"address": {

"street_address": "21 2nd Street",

"city": "New York",

"state": "NY",

"postal_code": "10021-3100"

"phone_numbers": [

{

"type": "home",

"number": "212 555-1234"

{

"type": "office",

"number": "646 555-4567"

}

"children": [

"Catherine",

"Thomas",

"Trevor"

"spouse": null

}

</syntaxhighlight>

Character encoding

Although Crockford originally asserted that JSON is a strict subset of JavaScript and ECMAScript, their specification actually allows valid JSON documents that are not valid JavaScript; JSON allows the Unicode line terminators and to appear unescaped in quoted strings, while ECMAScript 2018 and older do not.), but other languages implementing JSON may encode numbers differently.

String: a sequence of zero or more Unicode characters. Strings are delimited with double quotation marks and support a backslash escaping syntax.
Boolean: either of the values <code>true</code> or <code>false</code>
Array: an ordered list of zero or more elements, each of which may be of any type. Arrays use square bracket notation with comma-separated elements.
Object: a collection of name–value pairs where the names (also called keys) are strings. The current ECMA standard states, "The JSON syntax does not impose any restrictions on the strings used as names, does not require that name strings be unique, and does not assign any significance to the ordering of name/value pairs." Objects are delimited with curly brackets and use commas to separate each pair, while within each pair, the colon ":" character separates the key or name from its value.
<code>null</code>: an empty value, using the word <code>null</code>

Whitespace is allowed and ignored around or between syntactic elements (values and punctuation, but not within a string value). Four specific characters are considered whitespace for this purpose: space, horizontal tab, line feed, and carriage return. In particular, the byte order mark must not be generated by a conforming implementation (though it may be accepted when parsing JSON). JSON does not provide syntax for comments.

Comments were intentionally excluded from JSON. In 2012, Douglas Crockford described their design decision thus: "I removed comments from JSON because I saw people were using them to hold parsing directives, a practice which would have destroyed interoperability."

JSON disallows "trailing commas", a comma after the last value inside a data structure. Trailing commas are a common feature of JSON derivatives to improve ease of use.

Interoperability

describes certain aspects of JSON syntax that, while legal per the specifications, can cause interoperability problems.

Certain JSON implementations only accept JSON texts representing an object or an array. For interoperability, applications interchanging JSON should transmit messages that are objects or arrays.
The specifications allow JSON objects that contain multiple members with the same name. The behavior of implementations processing objects with duplicate names is unpredictable. For interoperability, applications should avoid duplicate names when transmitting JSON objects.
The specifications specifically say that the order of members in JSON objects is not significant. For interoperability, applications should avoid assigning meaning to member ordering even if the parsing software makes that ordering visible.
While the specifications place no limits on the magnitude or precision of JSON number literals, the widely used JavaScript implementation stores them as IEEE754 "binary64" quantities. For interoperability, applications should avoid transmitting numbers that cannot be represented in this way, for example, 1E400 or 3.141592653589793238462643383279.
While the specifications do not constrain the character encoding of the Unicode characters in a JSON text, the vast majority of implementations assume UTF-8 encoding; for interoperability, applications should always and only encode JSON messages in UTF-8.
The specifications do not forbid transmitting byte sequences that incorrectly represent Unicode characters. For interoperability, applications should transmit messages containing no such byte sequences.
The specification does not constrain how applications go about comparing Unicode strings. For interoperability, applications should always perform such comparisons code unit by code unit.

In 2015, the IETF published , describing the "I-JSON Message Format", a restricted profile of JSON that constrains the syntax and processing of JSON to avoid, as much as possible, these interoperability issues.

Semantics

While JSON provides a syntactic framework for data interchange, unambiguous data interchange also requires agreement between producer and consumer on the semantics of specific use of the JSON syntax. One example of where such an agreement is necessary is the serialization of data types that are not part of the JSON standard, for example, dates and regular expressions.

Metadata and schema

The official MIME type for JSON text is <code>application/json</code>, and most modern implementations have adopted this. Legacy MIME types include <code>text/json</code>, <code>text/x-json</code>, and <code>text/javascript</code>. The standard filename extension is .json.

JSON Schema specifies a JSON-based format to define the structure of JSON data for validation, documentation, and interaction control. It provides a contract for the JSON data required by a given application and how that data can be modified. JSON Schema is based on the concepts from XML Schema (XSD) but is JSON-based. As in XSD, the same serialization/deserialization tools can be used both for the schema and data, and it is self-describing. It is specified in an Internet Draft at the IETF, with the latest version as of 2024 being "Draft 2020-12". There are several validators available for different programming languages, each with varying levels of conformance.

The JSON standard does not support object references, but an IETF draft standard for JSON-based object references exists.

Uses

JSON-RPC is a remote procedure call (RPC) protocol built on JSON, as a replacement for XML-RPC or SOAP. It is a simple protocol that defines only a handful of data types and commands. JSON-RPC lets a system send notifications (information to the server that does not require a response) and multiple calls to the server that can be answered out of order.

Asynchronous JavaScript and JSON (or AJAJ) refers to the same dynamic web page methodology as Ajax, but instead of XML, JSON is the data format. AJAJ is a web development technique that provides for the ability of a web page to request new data after it has loaded into the web browser. Typically, it renders new data from the server in response to user actions on that web page. For example, what the user types into a search box, client-side code then sends to the server, which immediately responds with a drop-down list of matching database items.

JSON has seen ad hoc usage as a configuration language. However, it does not support comments.

In 2012, Douglas Crockford, JSON creator, had this to say about comments in JSON when used as a configuration language: "I know that the lack of comments makes some people sad, but it shouldn't. Suppose you are using JSON to keep configuration files, which you would like to annotate. Go ahead and insert all the comments you like. Then pipe it through JSMin before handing it to your JSON parser." and JSON in MySQL. This allows developers to insert JSON data directly without having to convert it to another format.

Safety

JSON being a subset of JavaScript can lead to the misconception that it is safe to pass JSON texts to the JavaScript <code>eval()</code> function. This is not safe, due to certain valid JSON texts, specifically those containing or , not being valid JavaScript code until JavaScript specifications were updated in 2019, and so older engines may not support it. To avoid the many pitfalls caused by executing arbitrary code from the Internet, a new function, , was first added to the fifth edition of ECMAScript, which as of 2017 is supported by all major browsers. For non-supported browsers, an API-compatible JavaScript library is provided by Douglas Crockford. In addition, the TC39 proposal "Subsume JSON" made ECMAScript a strict JSON superset as of the language's 2019 revision. Various JSON parser implementations have suffered from denial-of-service attack and mass assignment vulnerability.

Alternatives

JSON is promoted as a low-overhead alternative to XML as both of these formats have widespread support for creation, reading, and decoding in the real-world situations where they are commonly used. Depending on the specific use-case, JSON alternatives include:

For textual formats, CSV and supersets of JSON (see below). Ion also offers a textual format that's a JSON superset (wider range of primary types, annotations, comments, and allowing trailing commas). Google Protocol Buffers can also fill this niche due to the ability to be parsed without a schema, but it is not intended as an interchange language. In addition, databases such as SQLite and PostgreSQL have their own internal binary representations called "JSONB", not intended for outside use.

XML

XML has been used to describe structured data and to serialize objects. Various XML-based protocols exist to represent the same kind of data structures as JSON for the same kind of data interchange purposes. Data can be encoded in XML in several ways. The most expansive form using tag pairs results in a much larger (in character count) representation than JSON, but if data is stored in attributes and short tag form where the closing tag is replaced with , the representation is often about the same size as JSON or just a little larger. However, an XML attribute can only have a single value and each attribute can appear at most once on each element.

XML separates data from metadata (via the use of elements and attributes), while JSON does not have such a concept.

Another key difference is the addressing of values. JSON has objects with a simple key-to-value mapping, whereas in XML addressing happens on nodes, each of which receives a unique ID via the XML processor. Additionally, the XML standard defines a common attribute , that can be used by the user, to set an ID explicitly.

XML tag names cannot contain any of the characters <code>!"#$%&'()*+,/;<=>?@[\]^`{|}~</code>, nor a space character, and cannot begin with , , or a numeric digit, whereas JSON keys can (even if quotation mark and backslash must be escaped).

XML values are strings of characters, with no built-in type safety. XML has the concept of schema, that permits strong typing, user-defined types, predefined tags, and formal structure, allowing for formal validation of an XML stream. JSON has several types built-in and has a similar schema concept in JSON Schema.

XML supports comments, while JSON does not. HOCON, and JSON5 (which despite its name, is not the fifth version of JSON).

YAML

YAML version 1.2 is a superset of JSON; prior versions were not strictly compatible. For example, escaping a slash with a backslash is valid in JSON, but was not valid in YAML. YAML supports comments, while JSON does not.

There is also an unrelated project called CSON ("Cursive Script Object Notation") that is more syntactically similar to JSON.

HOCON

HOCON ("Human-Optimized Config Object Notation") is a format for human-readable data, and a superset of JSON.

The uses of HOCON are:

It is used mostly along with the Play Framework, and is developed by Lightbend.
It is also supported as a configuration format for .NET projects via Akka.NET and Puppet.
TIBCO Streaming: HOCON is the primary configuration file format for the TIBCO Streaming family of products (StreamBase, LiveView, and Artifact Management Server) as of TIBCO Streaming Release 10.
It is also the primary configuration file format for several subsystems of Exabeam Advanced Analytics.
Jitsi uses it as the "new" config system and .properties-Files as fallback

JSON5

JSON5 ("JSON5 Data Interchange Format") is an extension of JSON syntax that, like JSON, is also valid JavaScript syntax. The specification was started in 2012 and finished in 2018 with version 1.0.0. The main differences to JSON syntax are:

Optional trailing commas
Unquoted object keys
Single quoted and multiline strings
Additional number formats
Comments

JSON5 syntax is supported in some software as an extension of JSON syntax, for instance in SQLite.

JSONC

JSONC (JSON with Comments) is a subset of JSON5 used in Microsoft's Visual Studio Code:

supports single-line comments (<code>//</code>) and block comments (<code>/* */</code>)
accepts trailing commas, but they are discouraged and the editor will display a warning

Derivatives

Several serialization formats have been built on or from the JSON specification. Examples include

GeoJSON, a format designed for representing simple geographical features

JSON-LD, a method of encoding linked data using JSON
JSON-RPC, a remote procedure call protocol encoded in JSON
JsonML, a lightweight markup language used to map between XML and JSON
Smile (data interchange format)
UBJSON, a binary computer data interchange format imitating JSON, but requiring fewer bytes of data

Jsonnet is a prototype-based domain-specific language that produces JSON files. All JSON documents are valid Jsonnet programs that will be emitted unchanged when run. Jsonnet extends JSON by supporting variables, imports, loops, comments, etc. Jsonnet is used as a configuration language for cloud infrastructure engineering.