JSON

Source: Wikipedia, the free encyclopedia.

JavaScript Object Notation
Filename extension
.json
Internet media type
application/json
Open format?Yes
Websitejson.org

JSON (JavaScript Object Notation, pronounced

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 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 .json.

Douglas Crockford originally specified the JSON format in the early 2000s.[1] He 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 /ˈ.sən/, as in 'Jason and The Argonauts'".[2][3] The first (2013) edition of ECMA-404 did not address the pronunciation.[4] The UNIX and Linux System Administration Handbook states that "Douglas Crockford, who named and promoted the JSON format, says it's pronounced like the name Jason. But somehow, "JAY-sawn" seems to have become more common in the technical community."[5] Crockford said in 2011, "There's a lot of argument about how you pronounce that, but I strictly don't care."[6]

Standards

After

ISO/IEC 21778:2017.[2] The ECMA and ISO/IEC standards describe only the allowed syntax, whereas the RFC covers some security and interoperability considerations.[9]

History

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.[10]

Crockford first specified and popularized the JSON format.

Hypertext Transfer Protocol (HTTP) connections open and recycling them before standard browser time-outs if no further data were exchanged. The co-founders had a round-table discussion and voted whether to call the data format JSML (JavaScript Markup Language) or JSON (JavaScript Object Notation), as well as under what license type to make it available. The JSON.org[12] website was launched in 2001. In December 2005, Yahoo! began offering some of its Web services in JSON.[13]

A precursor to the JSON libraries was used in a children's digital asset trading game project named

.

JSON was based on a

programming languages. JSON's website lists JSON libraries
by language.

In October 2013,

RFC 8259, which is the current version of the Internet Standard STD 90.[15][16]

Crockford added a clause to the JSON license stating that "The Software shall be used for Good, not Evil", in order to

open-source the JSON libraries while mocking corporate lawyers and those who are overly pedantic. On the other hand, this clause led to license compatibility problems of the JSON license with other open-source licenses, as open-source software and free software usually imply no restrictions on the purpose of use.[17]

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
}

Character encoding

Although Crockford originally asserted that JSON is a strict subset of JavaScript and ECMAScript,[18] his specification actually allows valid JSON documents that are not valid JavaScript; JSON allows the Unicode line terminators U+2028 LINE SEPARATOR and U+2029 PARAGRAPH SEPARATOR to appear unescaped in quoted strings, while ECMAScript 2018 and older do not.[19][20] This is a consequence of JSON disallowing only "control characters". For maximum portability, these characters should be backslash-escaped.

JSON exchange in an open ecosystem must be encoded in

Basic Multilingual Plane (U+0000 to U+FFFF). However, if escaped, those characters must be written using UTF-16 surrogate pairs. For example, to include the Emoji
character U+1F610 😐 NEUTRAL FACE in JSON:

{ "face": "😐" }
// or
{ "face": "\uD83D\uDE10" }

JSON became a strict subset of ECMAScript as of the language's 2019 revision.[20][21]

Data types

JSON's basic data types are:

  • Number: a signed decimal number that may contain a fractional part and may use exponential
    E notation, but cannot include non-numbers such as NaN. The format makes no distinction between integer and floating-point. JavaScript uses IEEE-754 double-precision floating-point format for all its numeric values (later also supporting BigInt[22]
    ), 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 true or false
  • square bracket
    notation with comma-separated elements.
  • curly brackets
    and use commas to separate each pair, while within each pair the colon ':' character separates the key or name from its value.
  • null: an empty value, using the word null

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.[24]

Early versions of JSON (such as specified by

, where a JSON text was redefined as any serialized value.

Numbers in JSON are agnostic with regard to their representation within programming languages. While this allows for numbers of

signed zeros, but it does recommend expecting no more than IEEE 754 binary64 precision for "good interoperability". There is no inherent precision loss in serializing a machine-level binary representation of a floating-point number (like binary64) into a human-readable decimal representation (like numbers in JSON), and back, since there exist published algorithms to do this exactly and optimally.[25]

Comments were intentionally excluded from JSON. In 2012, Douglas Crockford described his 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."[24]

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

Interoperability

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

  • Certain JSON implementations only accept JSON texts which represent an object or an array. For interoperability, applications interchanging JSON should transmit messages which are objects or arrays.
  • The specifications allow JSON objects which 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 precisions of JSON number literals, the widely-used JavaScript implementation stores them as IEEE754 "binary64" quantities. For interoperability, applications should avoid transmitting numbers which 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 do not correctly 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 RFC7493, describing the "I-JSON Message Format", a restricted profile of JSON which 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.[28] 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 application/json,[29] and most modern implementations have adopted this. Legacy MIME types include text/json, text/x-json, and text/javascript.[30]

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.[31] 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".[32] There are several validators available for different programming languages,[33] each with varying levels of conformance. The standard filename extension is .json.[34]

The JSON standard does not support object

IETF draft standard for JSON-based object references exists.[35]

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.

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[36] before handing it to your JSON parser."[24]

MongoDB uses JSON-like data for its document-oriented database.

Some relational databases, such as PostgreSQL and MySQL, have added support for native JSON data types. This allows developers to store JSON data directly in a relational database without having to convert it to another data format.

Safety

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

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.[42] Apart from XML, examples could include CSV and supersets of JSON. Google Protocol Buffers can fill this role, although it is not a data interchange language. CBOR has a superset of the JSON data types, but it is not text-based.

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", which all receive a unique ID via the XML processor. Additionally, the XML standard defines a common attribute xml:id, that can be used by the user, to set an ID explicitly.

XML tag names cannot contain any of the characters !"#$%&'()*+,/;<=>?@[\]^`{|}~, 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).[43]

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.[44][24]

Supersets

Support for

HOCON, and JSON5 (which despite its name, is not the fifth version of JSON).[46][47]

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.[48] YAML supports comments, while JSON does not.[48][46][24]

CSON

CSON ("cursive script object notation"), is defined as tiny grammar additions to JSONs

ABNF grammar specified by RFC 4627. Like YAML, it is a strict superset of JSON. Contrary to YAML, every CSON data can be translated to JSON back and forth, so one can continue to use a library which only understands JSON, and one does not have to translate existing JSON. Besides such JSON equivalence, design considerations were:[49]

Libraries for C, JavaScript, Python, and Rust exist.

HOCON

HOCON ("Human-Optimized Config Object Notation" is a format for

human-readable data, and a superset of JSON.[50]
The uses of HOCON are:

JSON5

JSON5 ("JSON5 Data Interchange Format") is an extension of JSON syntax that just like JSON is also valid JavaScript syntax. The specification was started in 2012 and finished in 2018 with version 1.0.0.[61] 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 extension of JSON syntax, for instance in SQLite.[62]

JSONC

JSONC (JSON with comments) is a subset of JSON5 and primarily used by Microsoft:

  • supports single line comments (//) and block comments (/* */)
  • accepts trailing commas, but they are discouraged and the editor will display a warning[63]

Derivatives

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

  • GeoJSON, a format designed for representing simple geographical features[64][65]

See also

References

  1. ^ "Douglas Crockford: The JSON Saga". YouTube. August 28, 2011. Retrieved February 21, 2022.
  2. ^ a b c "ISO/IEC 21778:2017". ISO. Retrieved July 29, 2019.
  3. ^ "Standard ECMA-404 – The JSON Data Interchange Syntax" (PDF). Ecma International. December 2017. p. 1, footnote. Retrieved October 27, 2019.
  4. ^ ECMA-404: The JSON Data Interchange Format (PDF) (2nd ed.). Geneva: ECMA International. December 2017.
  5. . Retrieved October 29, 2019.
  6. ^ "Douglas Crockford: The JSON Saga – Transcript Vids". transcriptvids.com. Retrieved October 29, 2019.
  7. ^ a b "The JSON Data Interchange Format" (PDF). ECMA International. October 2013. Retrieved November 20, 2023.
  8. ^
    S2CID 263868313. Retrieved February 16, 2018. {{cite journal}}: Cite journal requires |journal= (help
    )
  9. ^ Bray, Tim. "JSON Redux AKA RFC7159". Ongoing. Retrieved March 16, 2014.
  10. ^ "Unofficial Java History". Edu4Java. 26 May 2014. Archived from the original on 26 May 2014. Retrieved 30 August 2019. In 1996, Macromedia launches Flash technology which occupies the space left by Java and ActiveX, becoming the de facto standard for animation on the client side.
  11. ^ "Douglas Crockford — The JSON Saga". YouTube. August 28, 2011. Retrieved September 23, 2016.
  12. ^ "JSON". json.org.
  13. ^ Yahoo!. "Using JSON with Yahoo! Web services". Archived from the original on October 11, 2007. Retrieved July 3, 2009.
  14. ^ Crockford, Douglas (May 28, 2009). "Introducing JSON". json.org. Retrieved July 3, 2009. It is based on a subset of the JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999.
  15. ^ Bray, Tim (December 2017). "History for draft-ietf-jsonbis-rfc7159bis-04". IETF Datatracker. Internet Engineering Task Force. Retrieved October 24, 2019. 2017-12-13 [...] RFC published
  16. ^ Bray, Tim (December 13, 2017). "RFC 8259 - The JavaScript Object Notation (JSON) Data Interchange Format". IETF Datatracker. Internet Engineering Task Force. Retrieved October 24, 2019. Type: RFC - Internet Standard (December 2017; Errata); Obsoletes RFC 7159; Also known as STD 90
  17. ^ "Apache and the JSON license" on LWN.net by Jake Edge (November 30, 2016).
  18. ^ Douglas Crockford (July 10, 2016). "JSON in JavaScript". Archived from the original on July 10, 2016. Retrieved August 13, 2016. JSON is a subset of the object literal notation of JavaScript.
  19. ^ Holm, Magnus (May 15, 2011). "JSON: The JavaScript subset that isn't". The timeless repository. Archived from the original on May 13, 2012. Retrieved September 23, 2016.
  20. ^ a b c "Subsume JSON: Proposal to make all JSON text valid ECMA-262". Ecma TC39. August 23, 2019. Retrieved August 27, 2019.
  21. ^ a b "Advance to Stage 4 - tc39/proposal-json-superset". GitHub. May 22, 2018.
  22. ^ "BigInt - MDN Web doc glossary". Mozilla. Retrieved October 18, 2020.
  23. ^ The JSON Data Interchange Syntax (PDF) (2nd ed.). Ecma International. December 2017. p. 3. 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.
  24. ^ a b c d e Crockford, Douglas (April 30, 2012). "Comments in JSON". Archived from the original on July 4, 2015. Retrieved August 30, 2019. I removed comments from JSON because I saw people were using them to hold parsing directives, a practice which would have destroyed interoperability. 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.
  25. ^ Andrysco, Marc; Jhala, Ranjit; Lerner, Sorin. "Printing Floating-Point Numbers - An Always Correct Method" (PDF). Retrieved July 27, 2019.
  26. ^ "Trailing commas - JavaScript | MDN". developer.mozilla.org. September 12, 2023. Retrieved December 16, 2023.
  27. ^ "JSON5". json5. Archived from the original on November 29, 2020. Retrieved December 16, 2020.
  28. ^ "The JSON Data Interchange Syntax" (PDF). Ecma International. December 2017. Retrieved October 27, 2019. The JSON syntax is not a specification of a complete data interchange. Meaningful data interchange requires agreement between a producer and consumer on the semantics attached to a particular use of the JSON syntax. What JSON does provide is the syntactic framework to which such semantics can be attached
  29. ^ "Media Types". iana.org. Retrieved September 13, 2015.
  30. ^ "Correct Content-Type Header for JSON". ReqBin. January 13, 2023. Retrieved March 23, 2024.
  31. ^ "JSON Schema and Hyper-Schema". json-schema.org. Retrieved June 8, 2021.
  32. ^ "JSON Schema - Specification Links". json-schema.org. Retrieved March 22, 2024.
  33. ^ "JSON Schema Implementations". json-schema.org. Retrieved June 8, 2021.
  34. S2CID 263868313
    .
  35. ^ Zyp, Kris (September 16, 2012). Bryan, Paul C. (ed.). "JSON Reference: draft-pbryan-zyp-json-ref-03". Internet Engineering Task Force.
  36. ^ Crockford, Douglas (May 16, 2019). "JSMin". Retrieved August 12, 2020. JSMin [2001] is a minification tool that removes comments and unnecessary whitespace from JavaScript files.
  37. ^ "JSON: The JavaScript subset that isn't". Magnus Holm. Archived from the original on May 13, 2012. Retrieved May 16, 2011.
  38. ^ "ECMAScript Fifth Edition" (PDF). Archived from the original (PDF) on April 14, 2011. Retrieved March 18, 2011.
  39. ^ "douglascrockford/JSON-js". GitHub. August 13, 2019.
  40. ^ "Denial of Service and Unsafe Object Creation Vulnerability in JSON (CVE-2013-0269)". Retrieved January 5, 2016.
  41. ^ "Microsoft .NET Framework JSON Content Processing Denial of Service Vulnerability". Archived from the original on November 6, 2018. Retrieved January 5, 2016.
  42. ^ "JSON: The Fat-Free Alternative to XML". json.org. Retrieved March 14, 2011.
  43. ^ "XML 1.1 Specification". World Wide Web Consortium. Retrieved August 26, 2019.
  44. .
  45. ^ Edelman, Jason; Lowe, Scott; Oswalt, Matt. Network Programmability and Automation. O'Reilly Media. for data representation you can pick one of the following: YAML, YAMLEX, JSON, JSON5, HJSON, or even pure Python
  46. ^ a b McCombs, Thayne (July 16, 2018). "Why JSON isn't a good configuration language". Lucid Chart. Retrieved June 15, 2019.
  47. ^ "HOCON (Human-Optimized Config Object Notation)". GitHub. January 28, 2019. Retrieved August 28, 2019. The primary goal is: keep the semantics (tree structure; set of types; encoding/escaping) from JSON, but make it more convenient as a human-editable config file format.
  48. ^ a b "YAML Ain't Markup Language (YAML™) Version 1.2". yaml.org. Retrieved September 13, 2015.
  49. ^ CSON, specification and README, last updated: 2021-07-01.
  50. ^ "config/HOCON.md at master · lightbend/config". GitHub. Retrieved August 5, 2021.
  51. ^ "Config File - 2.5.x". www.playframework.com. Retrieved August 5, 2021.
  52. ^ Akka.NET HOCON Docs
  53. ^ "Akka.NET Documentation | Akka.NET Documentation". getakka.net. Retrieved August 5, 2021.
  54. ^ "Managing HOCON configuration files with Puppet". Archived from the original on February 11, 2017. Retrieved March 4, 2023.
  55. ^ "StreamBase Documentation". docs.streambase.com. Retrieved August 5, 2021.
  56. ^ "Configuration Guide". docs.streambase.com. Retrieved August 5, 2021.
  57. ^ "StreamBase New and Noteworthy Archive". docs.streambase.com. Retrieved August 5, 2021.
  58. ^ "Exabeam Advanced Analytics Release Notes". Archived from the original on October 20, 2020. Retrieved March 4, 2023.
  59. ^ JITSI Project. "Config phase 1". GitHub. Retrieved February 16, 2021.
  60. ^ JITSI Project. "reference.conf". GitHub. Retrieved February 16, 2021.
  61. ^ "The JSON5 Data Interchange Format". Retrieved June 25, 2022.
  62. ^ SQLite. "JSON Functions And Operators". Retrieved June 25, 2023.
  63. ^ "JSON with Comments - JSON editing in Visual Studio Code". code.visualstudio.com. Retrieved October 2, 2023.
  64. ^ Butler, H.; Daly, M.; Doyle, A.; Gillies, Sean; Schaub, T.; Hagen, Stefan (August 2016). "RFC 7946 - The GeoJSON Format". IETF Datatracker. Retrieved June 17, 2022.
  65. ^ "GeoJSON". geojson.org. Retrieved August 7, 2022.
  66. ^ "JSON-LD 1.1". World Wide Web Consortium. July 16, 2020. Retrieved June 17, 2022.
  67. ^ "JSON-LD - JSON for Linking Data". json-ld.org. Retrieved August 7, 2022.
  68. ^ "JSON-RPC". jsonrpc.org. Retrieved June 17, 2022.
  69. ^ "JsonML (JSON Markup Language)". JsonML.org. Retrieved June 17, 2022.
  70. ^ McKamey, Stephen (June 14, 2022), JsonML, retrieved August 7, 2022
  71. ^ "FasterXML/smile-format-specification: New home for Smile format". GitHub. Retrieved June 17, 2022.
  72. ^ Gupta, Ayush (February 10, 2019). "Understanding Smile — A data format based on JSON". Code with Ayush. Retrieved August 7, 2022.
  73. ^ "Universal Binary JSON Specification – The universally compatible format specification for Binary JSON". ubjson.org. Retrieved June 17, 2022.
  74. ^ "UBJSON - JSON for Modern C++". json.nlohmann.me. Retrieved August 7, 2022.

External links

This page is based on the copyrighted Wikipedia article: JSON. Articles is available under the CC BY-SA 3.0 license; additional terms may apply.Privacy Policy