Jump to content

JSON: Difference between revisions

From Wikipedia, the free encyclopedia
Content deleted Content added
No edit summary
Tag: Reverted
m Consistency: name AND value pairs
 
(45 intermediate revisions by 31 users not shown)
Line 5: Line 5:
{{Infobox file format
{{Infobox file format
| name = JavaScript Object Notation
| name = JavaScript Object Notation
| icon = [[File:JSON vector logo.svg|121px]]
| logo = {{multiple image
<!-- Yes this is a terrible hack, a multiple image template with a single image. However, the infobox for file format does not support a logo caption. I don't want to fix it now, but if you want to: please do. Thanks. -->
| background color =
| align = center
| direction = vertical
| total_width = 121px
| image_style = border:none;
| border = infobox
| image1 = JSON vector logo.svg
| alt1 = The JSON logo is a [[Möbius strip]]
| caption1 = The JSON logo is a [[Möbius strip]]
}}
| logo_size = 121px
| logo_caption =
| mime = application/json
| mime = application/json
| type_code = TEXT
| type_code = TEXT
Line 18: Line 31:
}}
}}


'''JSON''' ('''JavaScript Object Notation''', pronounced {{IPAc-en|ˈ|dʒ|eɪ|s|ən}} is an [[open standard]] file format and [[Electronic data interchange|data interchange]] format that uses [[Human-readable medium|human-readable]] text to store and transmit data objects consisting of [[attribute–value pair]]s and [[array data type|array]]s (or other [[Serialization|serializable]] values). It is a commonly used data format with diverse uses in [[electronic data interchange]], including that of [[web application]]s with [[Server (computing)|server]]s.
'''JSON''' ('''JavaScript Object Notation''', pronounced {{IPAc-en|ˈ|dʒ|eɪ|s|ən}} or {{IPAc-en|ˈ|dʒ|eɪ|ˌ|s|ɒ|n}}) is an [[open standard]] file format and [[electronic data interchange|data interchange]] format that uses [[human-readable medium|human-readable]] text to store and transmit data objects consisting of [[name–value pair]]s and [[array data type|array]]s (or other [[serialization|serializable]] values). It is a commonly used data format with diverse uses in [[electronic data interchange]], including that of [[web application]]s with [[server (computing)|server]]s.


JSON is a [[Language-independent specification|language-independent]] data format. It was derived from [[JavaScript]], but many modern [[programming language]]s include code to generate and [[Parsing|parse]] JSON-format data. JSON filenames use the extension <code>.json</code>.
JSON is a [[Language-independent specification|language-independent]] data format. It was derived from [[JavaScript]], but many modern [[programming language]]s include code to generate and [[parsing|parse]] JSON-format data. JSON filenames use the extension <code>.json</code>.


[[Douglas Crockford]] originally specified the JSON format in the early 2000s.<ref name="saga">{{cite web|url=https://www.youtube.com/watch?v=-C-JoyNuQJs |title=Douglas Crockford: The JSON Saga |publisher=YouTube |date=2011-08-28 |access-date=2022-02-21}} Transcript: {{Webarchive |url=https://web.archive.org/web/20191030002009/transcriptvids.com/v/-C-JoyNuQJs.html |date=2019-10-30 |title=Transcript Vids}}</ref> He and [[Chip Morningstar]] sent the first JSON message in April 2001.
[[Douglas Crockford]] originally specified the JSON format in the early 2000s.<ref name="saga">{{cite web|url=https://www.youtube.com/watch?v=-C-JoyNuQJs |title=Douglas Crockford: The JSON Saga |publisher=YouTube |date=2011-08-28 |access-date=2022-02-21}} Transcript: {{Webarchive |url=https://web.archive.org/web/20191030002009/transcriptvids.com/v/-C-JoyNuQJs.html |date=2019-10-30 |title=Transcript Vids}}</ref> He and [[Chip Morningstar]] sent the first JSON message in April 2001.


== Naming and pronunciation ==
== Naming and pronunciation ==
The 2017 [[international standard]] (ECMA-404 and ISO/IEC 21778:2017) specifies that "JSON" is "pronounced {{IPAc-en|ˈ|dʒ|eɪ|·|s|ə|n}}, as in '[[Jason]] and The [[Argonauts]]{{'"}}.<ref name=":0"/><ref name="ecma2017">{{cite web |url=https://ecma-international.org/publications-and-standards/standards/ecma-404/ |title=ECMA-404: The JSON Data Interchange Syntax |publisher=[[Ecma International]] |date=December 2017 |edition=2nd |access-date=2024-04-29 |page=iii, footnote |url-status=live |archive-url=https://web.archive.org/web/20191027160438/www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf |archive-date=2019-10-27 |ref=ecma2017}}</ref> The first (2013) edition of ECMA-404 does not address the pronunciation.<ref name="ecma2013" /> The ''UNIX and Linux System Administration Handbook'' states, "[[Douglas Crockford]], who named and promoted the JSON format, says it's pronounced like the name Jason. But somehow, 'JAY-sawn'{{efn|{{IPAc-en|ˈ|dʒ|eɪ|ˌ|s|ɒ|n}}, assuming the [[cot-caught merger]]}} seems to have become more common in the technical community."<ref>{{cite book |last1=Nemeth |first1=Evi |last2=Snyder |first2=Garth |last3=Hein |first3=Trent R. |last4=Whaley |first4=Ben |last5=Mackin |first5=Dan |title=UNIX and Linux System Administration Handbook |date=2017 |publisher=Addison-Wesley Professional |isbn=9780134278292 |edition=5th |chapter-url=https://books.google.com/books?id=f7M1DwAAQBAJ&pg=PT1125 |access-date=29 October 2019 |language=en |chapter=19: Web Hosting}}</ref> Crockford said in 2011, "There's a lot of argument about how you pronounce that, but I strictly don't care."<ref name="saga"/>
The 2017 [[international standard]] (ECMA-404 and ISO/IEC 21778:2017) specifies that "JSON" is "pronounced {{IPAc-en|ˈ|dʒ|eɪ|·|s|ə|n}}, as in '[[Jason]] and The [[Argonauts]]{{'"}}.<ref name=":0"/><ref name="ecma2017">{{cite web |url=https://ecma-international.org/publications-and-standards/standards/ecma-404/ |title=ECMA-404: The JSON Data Interchange Syntax |publisher=[[Ecma International]] |date=December 2017 |edition=2nd |access-date=2024-04-29 |page=iii, footnote |url-status=live |archive-url=https://web.archive.org/web/20191027160438/www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf |archive-date=2019-10-27 |ref=ecma2017}}</ref> The first (2013) edition of ECMA-404 did not address the pronunciation.<ref name="ecma2013" /> The ''UNIX and Linux System Administration Handbook'' states, "[[Douglas Crockford]], who named and promoted the JSON format, says it's pronounced like the name Jason. But somehow, 'JAY-sawn'{{efn|{{IPAc-en|ˈ|dʒ|eɪ|ˌ|s|ɒ|n}}, assuming the [[cot-caught merger]]}} seems to have become more common in the technical community."<ref>{{cite book |last1=Nemeth |first1=Evi |last2=Snyder |first2=Garth |last3=Hein |first3=Trent R. |last4=Whaley |first4=Ben |last5=Mackin |first5=Dan |title=UNIX and Linux System Administration Handbook |date=2017 |publisher=Addison-Wesley Professional |isbn=9780134278292 |edition=5th |chapter-url=https://books.google.com/books?id=f7M1DwAAQBAJ&pg=PT1125 |access-date=29 October 2019 |language=en |chapter=19: Web Hosting}}</ref> Crockford said in 2011, "There's a lot of argument about how you pronounce that, but I strictly don't care."<ref name="saga"/>


== Standards ==
== Standards ==
After {{IETF RFC|4627}} had been available as its "informational" specification since 2006, JSON was first standardized in 2013, as [[Ecma International|ECMA]]-404.<ref name="ecma2013" /> {{IETF RFC|8259}}, published in 2017, is the current version of the [[Internet Standard]] [https://tools.ietf.org/html/std90 STD 90], and it remains consistent with ECMA-404.<ref name="rfc8259" /> That same year, JSON was also standardized as [[ISO]]/[[International Electrotechnical Commission|IEC]] 21778:2017.<ref name=":0">{{cite web|url=http://www.iso.org/cms/render/live/en/sites/isoorg/contents/data/standard/07/16/71616.html|title=ISO/IEC 21778:2017|website=ISO|access-date=29 July 2019|url-access=subscription}}</ref> The [[Ecma International|ECMA]] and [[International Organization for Standardization|ISO]]/[[International Electrotechnical Commission|IEC]] standards describe only the allowed syntax, whereas the RFC covers some security and interoperability considerations.<ref>{{cite web|last= Bray|first= Tim|title= JSON Redux AKA RFC7159|url= https://www.tbray.org/ongoing/When/201x/2014/03/05/RFC7159-JSON|work= Ongoing|access-date= 16 March 2014}}</ref>
After RFC 4627 had been available as its "informational" specification since 2006, JSON was first standardized in 2013, as [[Ecma International|ECMA]]-404.<ref name="ecma2013" /> RFC 8259, published in 2017, is the current version of the [[Internet Standard]] STD 90, and it remains consistent with ECMA-404.<ref name="rfc8259" /> That same year, JSON was also standardized as [[ISO]]/[[International Electrotechnical Commission|IEC]] 21778:2017.<ref name=":0">{{cite web|url=http://www.iso.org/cms/render/live/en/sites/isoorg/contents/data/standard/07/16/71616.html|title=ISO/IEC 21778:2017|website=ISO|access-date=29 July 2019|url-access=subscription}}</ref> The [[Ecma International|ECMA]] and [[International Organization for Standardization|ISO]]/[[International Electrotechnical Commission|IEC]] standards describe only the allowed syntax, whereas the RFC covers some security and interoperability considerations.<ref>{{cite web|last= Bray|first= Tim|title= JSON Redux AKA RFC7159|url= https://www.tbray.org/ongoing/When/201x/2014/03/05/RFC7159-JSON|work= Ongoing|access-date= 16 March 2014}}</ref>


==History==
==History==
Line 42: Line 55:
In October 2013, [[Ecma International]] published the first edition of its JSON standard ECMA-404.<ref name="ecma2013">{{cite web |date=October 2013 |edition=1st |title=ECMA-404: The JSON Data Interchange Format |url=https://ecma-international.org/publications-and-standards/standards/ecma-404/ |access-date=20 November 2023 |publisher=[[Ecma International]] |language=en |archive-url=https://web.archive.org/web/20131101200049/www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf |archive-date=2013-11-01 |url-status=live}}</ref> That same year, {{IETF RFC|7158}} used ECMA-404 as a reference. In 2014, {{IETF RFC|7159}} became the main reference for JSON's Internet uses, superseding {{IETF RFC|4627}} and {{IETF RFC|7158}} (but preserving ECMA-262 and ECMA-404 as main references). In November 2017, [[ISO/IEC JTC 1/SC 22]] published ISO/IEC 21778:2017<ref name=":0" /> as an international standard. On December 13, 2017, the [[Internet Engineering Task Force]] obsoleted {{IETF RFC|7159}} when it published {{IETF RFC|8259}}, which is the current version of the [[Internet Standard]] STD 90.<ref>{{cite journal |url=https://datatracker.ietf.org/doc/rfc8259/history/ |title=History for draft-ietf-jsonbis-rfc7159bis-04 |website=IETF Datatracker |date=December 2017 |publisher=Internet Engineering Task Force |access-date=2019-10-24 |quote=2017-12-13 [...] RFC published |last1=Bray |first1=Tim }}</ref><ref>{{cite journal | url = https://datatracker.ietf.org/doc/rfc8259/ |title=RFC 8259 - The JavaScript Object Notation (JSON) Data Interchange Format |website=IETF Datatracker |date=December 13, 2017 |publisher=Internet Engineering Task Force |access-date=2019-10-24 |quote=Type: RFC - Internet Standard (December 2017; Errata); Obsoletes RFC 7159; Also known as STD 90 |last1=Bray |first1=Tim }}</ref>
In October 2013, [[Ecma International]] published the first edition of its JSON standard ECMA-404.<ref name="ecma2013">{{cite web |date=October 2013 |edition=1st |title=ECMA-404: The JSON Data Interchange Format |url=https://ecma-international.org/publications-and-standards/standards/ecma-404/ |access-date=20 November 2023 |publisher=[[Ecma International]] |language=en |archive-url=https://web.archive.org/web/20131101200049/www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf |archive-date=2013-11-01 |url-status=live}}</ref> That same year, {{IETF RFC|7158}} used ECMA-404 as a reference. In 2014, {{IETF RFC|7159}} became the main reference for JSON's Internet uses, superseding {{IETF RFC|4627}} and {{IETF RFC|7158}} (but preserving ECMA-262 and ECMA-404 as main references). In November 2017, [[ISO/IEC JTC 1/SC 22]] published ISO/IEC 21778:2017<ref name=":0" /> as an international standard. On December 13, 2017, the [[Internet Engineering Task Force]] obsoleted {{IETF RFC|7159}} when it published {{IETF RFC|8259}}, which is the current version of the [[Internet Standard]] STD 90.<ref>{{cite journal |url=https://datatracker.ietf.org/doc/rfc8259/history/ |title=History for draft-ietf-jsonbis-rfc7159bis-04 |website=IETF Datatracker |date=December 2017 |publisher=Internet Engineering Task Force |access-date=2019-10-24 |quote=2017-12-13 [...] RFC published |last1=Bray |first1=Tim }}</ref><ref>{{cite journal | url = https://datatracker.ietf.org/doc/rfc8259/ |title=RFC 8259 - The JavaScript Object Notation (JSON) Data Interchange Format |website=IETF Datatracker |date=December 13, 2017 |publisher=Internet Engineering Task Force |access-date=2019-10-24 |quote=Type: RFC - Internet Standard (December 2017; Errata); Obsoletes RFC 7159; Also known as STD 90 |last1=Bray |first1=Tim }}</ref>


Crockford added a clause to the JSON license stating, "The Software shall be used for Good, not Evil", in order to [[Open-source model|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 license]]s since [[open-source software]] and [[free software]] usually imply no restrictions on the purpose of use.<ref>"[https://lwn.net/Articles/707510/ Apache and the JSON license]" on LWN.net by Jake Edge (November 30, 2016).</ref>
Crockford added a clause to the JSON license stating, "The Software shall be used for Good, not Evil", in order to [[open-source model|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 license]]s since [[open-source software]] and [[free software]] usually imply no restrictions on the purpose of use.<ref>"[https://lwn.net/Articles/707510/ Apache and the JSON license]" on LWN.net by Jake Edge (November 30, 2016).</ref>


== Syntax ==
== Syntax ==
Line 95: Line 108:


* 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|IEEE-754]] [[double-precision floating-point format]] for all its numeric values (later also supporting [[Arbitrary-precision arithmetic|BigInt]]<ref>{{cite web |title=BigInt - MDN Web doc glossary |url=https://developer.mozilla.org/en-US/docs/Glossary/BigInt |website=Mozilla |access-date=18 October 2020}}</ref>), but other languages implementing JSON may encode numbers differently.
* 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|IEEE-754]] [[double-precision floating-point format]] for all its numeric values (later also supporting [[Arbitrary-precision arithmetic|BigInt]]<ref>{{cite web |title=BigInt - MDN Web doc glossary |url=https://developer.mozilla.org/en-US/docs/Glossary/BigInt |website=Mozilla |access-date=18 October 2020}}</ref>), but other languages implementing JSON may encode numbers differently.
* [[String (computer science)|String]]: a sequence of [[Empty string|zero]] or more [[Unicode]] characters. Strings are delimited with double quotation marks and support a backslash [[Escape character|escaping]] syntax.
* [[String (computer science)|String]]: a sequence of [[empty string|zero]] or more [[Unicode]] characters. Strings are delimited with double quotation marks and support a backslash [[Escape character|escaping]] syntax.
* [[Boolean datatype|Boolean]]: either of the values <code>true</code> or <code>false</code>
* [[Boolean data type|Boolean]]: either of the values <code>true</code> or <code>false</code>
* [[Array data structure|Array]]: an [[List (abstract data type)|ordered list]] of zero or more elements, each of which may be of any type. Arrays use [[square bracket]] notation with comma-separated elements.
* [[Array data structure|Array]]: an [[List (abstract data type)|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 (computer science)|Object]]: a collection of [[Attribute–value pair|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."<ref>{{harvnb|ref=ecma2017|ECMA-404, 2nd ed.|page=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."</ref> Objects are delimited with [[Braces (punctuation)#Braces|curly brackets]] and use commas to separate each pair, while within each pair, the colon ':' character separates the key or name from its value.
* [[Object (computer science)|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."<ref>{{harvnb|ref=ecma2017|ECMA-404, 2nd ed.|page=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."</ref> Objects are delimited with [[Braces (punctuation)#Braces|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>[[Nullable type|null]]</code>: an empty value, using the word <code>null</code>
* <code>[[Nullable type|null]]</code>: an empty value, using the word <code>null</code>


Line 112: Line 125:


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

[https://www.rfc-editor.org/rfc/rfc8259.html RFC 8259] 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.
* 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.
Line 123: Line 135:
* 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.
* 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 [https://www.rfc-editor.org/rfc/rfc7493.html RFC7493], 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.
In 2015, the IETF published RFC 7493, 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 ===
=== Semantics ===
Line 131: Line 143:
The official [[MIME type]] for JSON text is <code>application/json</code>,<ref>{{cite web|url=https://www.iana.org/assignments/media-types/application/index.html|title=Media Types|work=iana.org|access-date=13 September 2015}}</ref> 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>.<ref>{{Cite web |date=2023-01-13 |title=Correct Content-Type Header for JSON |url=https://reqbin.com/req/abghm4zf/json-content-type |access-date=2024-03-23 |website=ReqBin}}</ref>
The official [[MIME type]] for JSON text is <code>application/json</code>,<ref>{{cite web|url=https://www.iana.org/assignments/media-types/application/index.html|title=Media Types|work=iana.org|access-date=13 September 2015}}</ref> 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>.<ref>{{Cite web |date=2023-01-13 |title=Correct Content-Type Header for JSON |url=https://reqbin.com/req/abghm4zf/json-content-type |access-date=2024-03-23 |website=ReqBin}}</ref>


''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.<ref>{{cite web|url=https://json-schema.org//|title=JSON Schema and Hyper-Schema|work=json-schema.org|access-date=8 June 2021}}</ref> JSON Schema is based on the concepts from [[XML Schema (W3C)|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".<ref>{{Cite web |title=JSON Schema - Specification Links |url=https://json-schema.org/specification-links |access-date=2024-03-22 |website=json-schema.org}}</ref> There are several validators available for different programming languages,<ref>{{cite web|url=https://json-schema.org/implementations.html|title=JSON Schema Implementations|work=json-schema.org|access-date=8 June 2021}}</ref> each with varying levels of conformance. The standard filename extension is .json.<ref>{{cite journal |url=https://datatracker.ietf.org/doc/html/rfc8259#section-11 |title=11. IANA Considerations |journal=RFC 8259: The JavaScript Object Notation (JSON) Data Interchange Format |date=December 2017 |publisher=[[IETF]] |last1=Bray |first1=Tim |editor-first1=T. |editor-last1=Bray |doi=10.17487/RFC8259 |s2cid=263868313 }}</ref>
''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.<ref>{{cite web|url=https://json-schema.org//|title=JSON Schema and Hyper-Schema|work=json-schema.org|access-date=8 June 2021}}</ref> JSON Schema is based on the concepts from [[XML Schema (W3C)|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".<ref>{{Cite web |title=JSON Schema - Specification Links |url=https://json-schema.org/specification-links |access-date=2024-03-22 |website=json-schema.org}}</ref> There are several validators available for different programming languages,<ref>{{cite web|url=https://json-schema.org/implementations.html|title=JSON Schema Implementations|work=json-schema.org|access-date=8 June 2021 |archive-date=2021-06-16 |archive-url=https://web.archive.org/web/20210616234051/json-schema.org/implementations.html |url-status=dead}}</ref> each with varying levels of conformance. The standard filename extension is .json.<ref>{{cite journal |url=https://datatracker.ietf.org/doc/html/rfc8259#section-11 |title=11. IANA Considerations |journal=RFC 8259: The JavaScript Object Notation (JSON) Data Interchange Format |date=December 2017 |publisher=[[IETF]] |last1=Bray |first1=Tim |editor-first1=T. |editor-last1=Bray |doi=10.17487/RFC8259 |s2cid=263868313 }}</ref>


The JSON standard does not support object [[Reference (computer science)|references]], but an [[IETF]] draft standard for JSON-based object references exists.<ref>{{cite journal |last=Zyp |first=Kris |editor-last=Bryan |editor-first=Paul C. |title=JSON Reference: draft-pbryan-zyp-json-ref-03 |website=Internet Engineering Task Force |date=September 16, 2012|url=https://datatracker.ietf.org/doc/html/draft-pbryan-zyp-json-ref-03 }}</ref>
The JSON standard does not support object [[Reference (computer science)|references]], but an [[IETF]] draft standard for JSON-based object references exists.<ref>{{cite journal |last=Zyp |first=Kris |editor-last=Bryan |editor-first=Paul C. |title=JSON Reference: draft-pbryan-zyp-json-ref-03 |website=Internet Engineering Task Force |date=September 16, 2012|url=https://datatracker.ietf.org/doc/html/draft-pbryan-zyp-json-ref-03 }}</ref>
Line 148: Line 160:
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.
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==
== 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 {{unichar|2028|LINE SEPARATOR}} or {{unichar|2029|PARAGRAPH SEPARATOR}}, not being valid JavaScript code until JavaScript specifications were updated in 2019, and so older engines may not support it.<ref name="Magnus Holm">{{cite web|title=JSON: The JavaScript subset that isn't|url=http://timelessrepo.com/json-isnt-a-javascript-subset|publisher=Magnus Holm|access-date=16 May 2011|archive-date=May 13, 2012|archive-url=https://web.archive.org/web/20120513012409/http://timelessrepo.com/json-isnt-a-javascript-subset|url-status=dead}}</ref> To avoid the many pitfalls caused by executing arbitrary code from the Internet, a new function, {{code|lang=javascript|code=JSON.parse()}}, was first added to the fifth edition of ECMAScript,<ref>{{cite web|url=https://ecma-international.org/publications-and-standards/standards/ecma-262/|title=ECMA-262: ECMAScript Language Specification |edition=5th |date=December 2009|access-date=March 18, 2011|archive-url=https://web.archive.org/web/20110414214458/http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-262.pdf|archive-date=April 14, 2011|url-status=live|df=mdy-all}}</ref> which as of 2017 is supported by all major browsers. For non-supported browsers, an API-compatible JavaScript library is provided by [[Douglas Crockford]].<ref>{{cite web|url=https://github.com/douglascrockford/JSON-js/blob/master/json2.js|title=douglascrockford/JSON-js|website=GitHub|date=2019-08-13}}</ref> In addition, the TC39 proposal [https://github.com/tc39/proposal-json-superset "Subsume JSON"] made [[ECMAScript]] a strict JSON superset as of the language's 2019 revision.<ref name=ECMATC39>{{cite web |title=Subsume JSON: Proposal to make all JSON text valid ECMA-262 |url=https://tc39.es/proposal-json-superset/ |publisher=Ecma TC39 |access-date=27 August 2019 |date=23 August 2019}}</ref><ref name=ECMATC39Stage4>{{cite web |title=Advance to Stage 4 - tc39/proposal-json-superset |url=https://github.com/tc39/proposal-json-superset/commit/0604b6083e18fe033a1520388b8c6146bcd79e23|website=GitHub|date=May 22, 2018}}</ref>
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 {{unichar|2028|LINE SEPARATOR}} or {{unichar|2029|PARAGRAPH SEPARATOR}}, not being valid JavaScript code until JavaScript specifications were updated in 2019, and so older engines may not support it.<ref name="Magnus Holm">{{cite web|title=JSON: The JavaScript subset that isn't|url=http://timelessrepo.com/json-isnt-a-javascript-subset|publisher=Magnus Holm|access-date=16 May 2011|archive-date=May 13, 2012|archive-url=https://web.archive.org/web/20120513012409/http://timelessrepo.com/json-isnt-a-javascript-subset|url-status=dead}}</ref> To avoid the many pitfalls caused by executing arbitrary code from the Internet, a new function, {{code|lang=javascript|code=JSON.parse()}}, was first added to the fifth edition of ECMAScript,<ref>{{cite web|url=https://ecma-international.org/publications-and-standards/standards/ecma-262/|title=ECMA-262: ECMAScript Language Specification |edition=5th |date=December 2009|access-date=March 18, 2011|archive-url=https://web.archive.org/web/20110414214458/http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-262.pdf|archive-date=April 14, 2011|url-status=live|df=mdy-all}}</ref> which as of 2017 is supported by all major browsers. For non-supported browsers, an API-compatible JavaScript library is provided by [[Douglas Crockford]].<ref>{{cite web|url=https://github.com/douglascrockford/JSON-js/blob/master/json2.js|title=douglascrockford/JSON-js|website=GitHub|date=2019-08-13}}</ref> In addition, the TC39 proposal "Subsume JSON" made [[ECMAScript]] a strict JSON superset as of the language's 2019 revision.<ref name=ECMATC39>{{cite web |title=Subsume JSON: Proposal to make all JSON text valid ECMA-262 |url=https://tc39.es/proposal-json-superset/ |publisher=Ecma TC39 |access-date=27 August 2019 |date=23 August 2019}}</ref><ref name=ECMATC39Stage4>{{cite web |title=Advance to Stage 4 - tc39/proposal-json-superset |url=https://github.com/tc39/proposal-json-superset/commit/0604b6083e18fe033a1520388b8c6146bcd79e23|website=GitHub|date=May 22, 2018}}</ref> Various JSON parser implementations have suffered from [[denial-of-service attack]] and [[mass assignment vulnerability]].<ref>{{cite web | url=https://www.ruby-lang.org/en/news/2013/02/22/json-dos-cve-2013-0269/ | title=Denial of Service and Unsafe Object Creation Vulnerability in JSON (CVE-2013-0269) | access-date=January 5, 2016}}</ref><ref>{{cite web | url=http://tools.cisco.com/security/center/viewAlert.x?alertId=31048 | title=Microsoft .NET Framework JSON Content Processing Denial of Service Vulnerability | archive-url=https://web.archive.org/web/20181106233952/http://tools.cisco.com/security/center/viewAlert.x?alertId=31048 | access-date=January 5, 2016| archive-date=November 6, 2018 }}</ref>
Various JSON parser implementations have suffered from [[denial-of-service attack]] and [[mass assignment vulnerability]].<ref>{{cite web | url=https://www.ruby-lang.org/en/news/2013/02/22/json-dos-cve-2013-0269/ | title=Denial of Service and Unsafe Object Creation Vulnerability in JSON (CVE-2013-0269) | access-date=January 5, 2016}}</ref><ref>{{cite web | url=http://tools.cisco.com/security/center/viewAlert.x?alertId=31048 | title=Microsoft .NET Framework JSON Content Processing Denial of Service Vulnerability | archive-url=https://web.archive.org/web/20181106233952/http://tools.cisco.com/security/center/viewAlert.x?alertId=31048 | access-date=January 5, 2016| archive-date=November 6, 2018 }}</ref>


== Alternatives ==
== Alternatives ==
{{See also|Comparison of data-serialization formats}}
{{See also|Comparison of data-serialization formats}}


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.<ref>{{cite web|title=JSON: The Fat-Free Alternative to XML|url=http://www.json.org/xml.html|publisher=json.org|access-date=14 March 2011}}</ref> Apart from XML, examples could include [[Comma-separated values|CSV]] and [[#Supersets|supersets]] of JSON. [[Protocol Buffers|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.
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.<ref>{{cite web|title=JSON: The Fat-Free Alternative to XML|url=http://www.json.org/xml.html|publisher=json.org|access-date=14 March 2011}}</ref> Apart from XML, examples could include [[Comma-separated values|CSV]] and [[#Supersets|supersets]] of JSON. [[Protocol Buffers|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. [[Ion_(serialization_format) | Ion]] is also a superset of JSON, with a wider range of primary types, annotations, comments, and allowing trailing commas.<ref name="ion">{{cite web |title=Amazon Ion |url=https://amazon-ion.github.io/ion-docs/index.html |publisher=[[Amazon (company)|Amazon]] |access-date=26 August 2024 |archive-url=https://web.archive.org/web/20240812225059/amazon-ion.github.io/ion-docs/index.html |archive-date=2024-08-12 |language=en |url-status=live}}</ref>


=== XML ===
=== XML ===
Line 172: Line 183:
XML supports comments, while JSON does not.<ref name=Saternos45>{{cite book|last1=Saternos|first1=Casimir|title=Client-server web apps with Javascript and Java|date=2014|isbn=9781449369316|page=45|publisher="O'Reilly Media, Inc." }}</ref><ref name=DouglasCrockfordComments/>
XML supports comments, while JSON does not.<ref name=Saternos45>{{cite book|last1=Saternos|first1=Casimir|title=Client-server web apps with Javascript and Java|date=2014|isbn=9781449369316|page=45|publisher="O'Reilly Media, Inc." }}</ref><ref name=DouglasCrockfordComments/>


==Supersets==
== Supersets ==

Support for [[Comment (computer programming)|comments]] and other features have been deemed useful, which has led to several nonstandard JSON [[superset]]s being created. Among them are HJSON,<ref>{{cite book|last1=Edelman|first1=Jason|last2=Lowe|first2=Scott|last3=Oswalt|first3=Matt|title=Network Programmability and Automation|publisher=[[O'Reilly Media]]|quote=for data representation you can pick one of the following: YAML, YAMLEX, JSON, JSON5, HJSON, or even pure Python}}</ref> HOCON, and JSON5 (which despite its name, is not the fifth version of JSON).<ref name=lucidchart/><ref>{{cite web | url=https://github.com/lightbend/config/blob/master/HOCON.md |title=HOCON (Human-Optimized Config Object Notation) |date=2019-01-28 |website=GitHub |access-date=2019-08-28 |quote=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.}}</ref>
Support for [[Comment (computer programming)|comments]] and other features have been deemed useful, which has led to several nonstandard JSON [[superset]]s being created. Among them are HJSON,<ref>{{cite book|last1=Edelman|first1=Jason|last2=Lowe|first2=Scott|last3=Oswalt|first3=Matt|title=Network Programmability and Automation|publisher=[[O'Reilly Media]]|quote=for data representation you can pick one of the following: YAML, YAMLEX, JSON, JSON5, HJSON, or even pure Python}}</ref> HOCON, and JSON5 (which despite its name, is not the fifth version of JSON).<ref name=lucidchart/><ref>{{cite web | url=https://github.com/lightbend/config/blob/master/HOCON.md |title=HOCON (Human-Optimized Config Object Notation) |date=2019-01-28 |website=GitHub |access-date=2019-08-28 |quote=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.}}</ref>


Line 193: Line 203:
* TIBCO Streaming:<ref>{{Cite web|title=StreamBase Documentation|url=https://docs.streambase.com/latest/index.jsp|access-date=2021-08-05|website=docs.streambase.com}}</ref> HOCON is the primary configuration file format for the TIBCO Streaming<ref>{{Cite web|title=Configuration Guide|url=https://docs.streambase.com/latest/topic/com.streambase.sb.ide.help/data/html/hocon/index.html|access-date=2021-08-05|website=docs.streambase.com}}</ref> family of products (StreamBase, LiveView, and Artifact Management Server) as of TIBCO Streaming Release 10.<ref>{{Cite web|title=StreamBase New and Noteworthy Archive|url=https://docs.streambase.com/latest/topic/com.streambase.sb.ide.help/data/html/dochome/xarchive-sb-noteworthy.html|access-date=2021-08-05|website=docs.streambase.com}}</ref>
* TIBCO Streaming:<ref>{{Cite web|title=StreamBase Documentation|url=https://docs.streambase.com/latest/index.jsp|access-date=2021-08-05|website=docs.streambase.com}}</ref> HOCON is the primary configuration file format for the TIBCO Streaming<ref>{{Cite web|title=Configuration Guide|url=https://docs.streambase.com/latest/topic/com.streambase.sb.ide.help/data/html/hocon/index.html|access-date=2021-08-05|website=docs.streambase.com}}</ref> family of products (StreamBase, LiveView, and Artifact Management Server) as of TIBCO Streaming Release 10.<ref>{{Cite web|title=StreamBase New and Noteworthy Archive|url=https://docs.streambase.com/latest/topic/com.streambase.sb.ide.help/data/html/dochome/xarchive-sb-noteworthy.html|access-date=2021-08-05|website=docs.streambase.com}}</ref>
* It is also the primary configuration file format for several subsystems of Exabeam Advanced Analytics.<ref>{{Cite web |url=https://docs.exabeam.com/en/advanced-analytics/i48/release-notes/109536-what-s-new.html |title=Exabeam Advanced Analytics Release Notes |access-date=March 4, 2023 |archive-date=October 20, 2020 |archive-url=https://web.archive.org/web/20201020195403/https://docs.exabeam.com/en/advanced-analytics/i48/release-notes/109536-what-s-new.html |url-status=dead }}</ref>
* It is also the primary configuration file format for several subsystems of Exabeam Advanced Analytics.<ref>{{Cite web |url=https://docs.exabeam.com/en/advanced-analytics/i48/release-notes/109536-what-s-new.html |title=Exabeam Advanced Analytics Release Notes |access-date=March 4, 2023 |archive-date=October 20, 2020 |archive-url=https://web.archive.org/web/20201020195403/https://docs.exabeam.com/en/advanced-analytics/i48/release-notes/109536-what-s-new.html |url-status=dead }}</ref>
* [[Jitsi]] uses it as the "new" config system and [[.properties]]-Files as fallback<ref>{{cite web |url=https://github.com/jitsi/jitsi-videobridge/commit/676fb3df696c4737ac086fb856af1f85c6ded90e|title=Config phase 1|author=JITSI Project|website=[[GitHub]] |access-date=2021-02-16}}</ref><ref>{{ cite web| url=https://github.com/jitsi/jicofo/blob/master/src/main/resources/reference.conf| title=reference.conf| author=JITSI Project| website=[[GitHub]]| access-date=2021-02-16}}</ref>
* [[Jitsi]] uses it as the "new" config system and [[.properties]]-Files as fallback<ref>{{cite web |url=https://github.com/jitsi/jitsi-videobridge/commit/676fb3df696c4737ac086fb856af1f85c6ded90e|title=Config phase 1|author=JITSI Project|website=[[GitHub]] |access-date=2021-02-16}}</ref><ref>{{ cite web| url=https://github.com/jitsi/jicofo/blob/add-selection-test/src/main/resources/reference.conf| title=reference.conf| author=JITSI Project| website=[[GitHub]]| access-date=2021-02-16}}</ref>


=== JSON5 ===
=== 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.<ref>{{cite web|url=https://spec.json5.org/|title=The JSON5 Data Interchange Format|access-date=2022-06-25}}</ref> The main differences to JSON syntax are:
'''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.<ref>{{cite web|url=https://spec.json5.org/|title=The JSON5 Data Interchange Format|access-date=2022-06-25}}</ref> The main differences to JSON syntax are:


* Optional trailing commas
* Optional trailing commas
Line 204: Line 214:
* Comments
* Comments


JSON5 syntax is supported in some software as extension of JSON syntax, for instance in [[SQLite]].<ref>{{cite web|url=https://www.sqlite.org/json1.html#json5_extensions|author=SQLite|access-date=2023-06-25|title=JSON Functions And Operators}}</ref>
JSON5 syntax is supported in some software as an extension of JSON syntax, for instance in [[SQLite]].<ref>{{cite web|url=https://www.sqlite.org/json1.html#json5_extensions|author=SQLite|access-date=2023-06-25|title=JSON Functions And Operators}}</ref>


=== JSONC ===
=== JSONC ===
Line 225: Line 235:
* [[BSON]]
* [[BSON]]
* [[Comparison of data serialization formats]]
* [[Comparison of data serialization formats]]
* Amazon [[Ion (serialization format)|Ion]]{{snd}} a superset of JSON
* Amazon [[Ion (serialization format)|Ion]]{{snd}} a superset of JSON (though limited to [[UTF-8]], like JSON for interchange, unlike general JSON)
* [[Jackson (API)]]
* [[Jackson (API)]]
* [[jaql]] - a functional data processing and query language most commonly used for JSON query processing
* [[jaql]] a functional data processing and query language most commonly used for JSON query processing
* [[jq (programming language)|jq]] - a "JSON query language" and high-level programming language
* [[jq (programming language)|jq]] a "JSON query language" and high-level programming language
* [[JSONiq]] - a JSON-oriented query and processing language based on [[XQuery]]
* [[JSONiq]] a JSON-oriented query and processing language based on [[XQuery]]
* [[JSON streaming]]
* [[JSON streaming]]
* [[S-expression]]
* [[S-expression]]
* [[Module:TNT|Wikipedia TNT Module]]


== Notes ==
== Notes ==

Latest revision as of 17:21, 4 November 2024

JavaScript Object Notation
The JSON logo is a Möbius strip
The JSON logo is a Möbius strip
Filename extension
.json
Internet media type
application/json
Type codeTEXT
Uniform Type Identifier (UTI)public.json
Type of formatData interchange
Extended fromJavaScript
StandardSTD 90 (RFC 8259), ECMA-404, ISO/IEC 21778:2017
Open format?Yes
Websitejson.org

JSON (JavaScript Object Notation, pronounced /ˈsən/ or /ˈˌsɒn/) 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 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

[edit]

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, "Douglas Crockford, who named and promoted the JSON format, says it's pronounced like the name Jason. But somehow, 'JAY-sawn'[a] 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."[1]

Standards

[edit]

After RFC 4627 had been available as its "informational" specification since 2006, JSON was first standardized in 2013, as ECMA-404.[4] RFC 8259, published in 2017, is the current version of the Internet Standard STD 90, and it remains consistent with ECMA-404.[6] That same year, JSON was also standardized as 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.[7]

History

[edit]
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.[8]

Crockford first specified and popularized the JSON format.[1] The acronym originated at State Software, a company cofounded by Crockford and others in March 2001. The cofounders agreed to build a system that used standard browser capabilities and provided an abstraction layer for Web developers to create stateful Web applications that had a persistent duplex connection to a Web server by holding two Hypertext Transfer Protocol (HTTP) connections open and recycling them before standard browser time-outs if no further data were exchanged. The cofounders had a round-table discussion and voted on 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[9] website was launched in 2001. In December 2005, Yahoo! began offering some of its Web services in JSON.[10]

A precursor to the JSON libraries was used in a children's digital asset trading game project named Cartoon Orbit at Communities.com [citation needed] (the State cofounders had all worked at this company previously) for Cartoon Network [citation needed], which used a browser side plug-in with a proprietary messaging format to manipulate DHTML elements (this system is also owned by 3DO [citation needed]). 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[11]) 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.[4] That same year, RFC 7158 used ECMA-404 as a reference. In 2014, RFC 7159 became the main reference for JSON's Internet uses, superseding RFC 4627 and RFC 7158 (but preserving ECMA-262 and ECMA-404 as main references). In November 2017, ISO/IEC JTC 1/SC 22 published ISO/IEC 21778:2017[2] as an international standard. On December 13, 2017, the Internet Engineering Task Force obsoleted RFC 7159 when it published RFC 8259, which is the current version of the Internet Standard STD 90.[12][13]

Crockford added a clause to the JSON license stating, "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 since open-source software and free software usually imply no restrictions on the purpose of use.[14]

Syntax

[edit]

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

[edit]

Although Crockford originally asserted that JSON is a strict subset of JavaScript and ECMAScript,[15] 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.[16][17] 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 UTF-8.[6] The encoding supports the full Unicode character set, including those characters outside the 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.[17][18]

Data types

[edit]

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[19]), 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
  • 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."[20] 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.
  • null: an empty value, using the word null

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

Early versions of JSON (such as specified by RFC 4627) required that a valid JSON text must consist of only an object or an array type, which could contain other types within them. This restriction was dropped in RFC 7158, 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 arbitrary precision to be serialized, it may lead to portability issues. For example, since no differentiation is made between integer and floating-point values, some implementations may treat 42, 42.0, and 4.2E+1 as the same number, while others may not. The JSON standard makes no requirements regarding implementation details such as overflow, underflow, loss of precision, rounding, or 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.[22]

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."[21]

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

Interoperability

[edit]

RFC 8259 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 precisions 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 RFC 7493, 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

[edit]

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

[edit]

The official MIME type for JSON text is application/json,[26] and most modern implementations have adopted this. Legacy MIME types include text/json, text/x-json, and text/javascript.[27]

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

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

Uses

[edit]

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

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

[edit]

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.[34] 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,[35] which as of 2017 is supported by all major browsers. For non-supported browsers, an API-compatible JavaScript library is provided by Douglas Crockford.[36] In addition, the TC39 proposal "Subsume JSON" made ECMAScript a strict JSON superset as of the language's 2019 revision.[17][18] Various JSON parser implementations have suffered from denial-of-service attack and mass assignment vulnerability.[37][38]

Alternatives

[edit]

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.[39] 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. Ion is also a superset of JSON, with a wider range of primary types, annotations, comments, and allowing trailing commas.[40]

XML

[edit]

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).[41]

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.[42][21]

Supersets

[edit]

Support for comments and other features have been deemed useful, which has led to several nonstandard JSON supersets being created. Among them are HJSON,[43] HOCON, and JSON5 (which despite its name, is not the fifth version of JSON).[44][45]

YAML

[edit]

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

CSON

[edit]

CSON ("CoffeeScript Object Notation") uses significant indentation, unquoted keys, and assumes an outer object declaration. It was used for configuring GitHub's Atom text editor.[47][48][49]

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

HOCON

[edit]

HOCON ("Human-Optimized Config Object Notation") is a format for human-readable data, and a superset of JSON.[51] The uses of HOCON are:

  • It is primarily used in conjunction with the Play framework,[52] and is developed by Lightbend.
  • It is also supported as a configuration format for .NET projects via Akka.NET[53][54] and Puppet.[55]
  • TIBCO Streaming:[56] HOCON is the primary configuration file format for the TIBCO Streaming[57] family of products (StreamBase, LiveView, and Artifact Management Server) as of TIBCO Streaming Release 10.[58]
  • It is also the primary configuration file format for several subsystems of Exabeam Advanced Analytics.[59]
  • Jitsi uses it as the "new" config system and .properties-Files as fallback[60][61]

JSON5

[edit]

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.[62] 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.[63]

JSONC

[edit]

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

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

Derivatives

[edit]

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

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

See also

[edit]

Notes

[edit]

References

[edit]
  1. ^ a b c "Douglas Crockford: The JSON Saga". YouTube. August 28, 2011. Retrieved February 21, 2022. Transcript: Transcript Vids at the Wayback Machine (archived 2019-10-30)
  2. ^ a b c "ISO/IEC 21778:2017". ISO. Retrieved July 29, 2019.
  3. ^ "ECMA-404: The JSON Data Interchange Syntax" (2nd ed.). Ecma International. December 2017. p. iii, footnote. Archived (PDF) from the original on October 27, 2019. Retrieved April 29, 2024.
  4. ^ a b c "ECMA-404: The JSON Data Interchange Format" (1st ed.). Ecma International. October 2013. Archived (PDF) from the original on November 1, 2013. Retrieved November 20, 2023.
  5. ^ Nemeth, Evi; Snyder, Garth; Hein, Trent R.; Whaley, Ben; Mackin, Dan (2017). "19: Web Hosting". UNIX and Linux System Administration Handbook (5th ed.). Addison-Wesley Professional. ISBN 9780134278292. Retrieved October 29, 2019.
  6. ^ a b Bray, T. (December 2017). Bray, T (ed.). "The JavaScript Object Notation (JSON) Data Interchange Format". IETF. doi:10.17487/RFC8259. S2CID 263868313. Retrieved February 16, 2018. {{cite journal}}: Cite journal requires |journal= (help)
  7. ^ Bray, Tim. "JSON Redux AKA RFC7159". Ongoing. Retrieved March 16, 2014.
  8. ^ "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.
  9. ^ "JSON". json.org.
  10. ^ Yahoo!. "Using JSON with Yahoo! Web services". Archived from the original on October 11, 2007. Retrieved July 3, 2009.
  11. ^ 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.
  12. ^ 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
  13. ^ 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
  14. ^ "Apache and the JSON license" on LWN.net by Jake Edge (November 30, 2016).
  15. ^ 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.
  16. ^ 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.
  17. ^ a b c "Subsume JSON: Proposal to make all JSON text valid ECMA-262". Ecma TC39. August 23, 2019. Retrieved August 27, 2019.
  18. ^ a b "Advance to Stage 4 - tc39/proposal-json-superset". GitHub. May 22, 2018.
  19. ^ "BigInt - MDN Web doc glossary". Mozilla. Retrieved October 18, 2020.
  20. ^ ECMA-404, 2nd ed., 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."
  21. ^ 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.
  22. ^ Andrysco, Marc; Jhala, Ranjit; Lerner, Sorin. "Printing Floating-Point Numbers - An Always Correct Method" (PDF). Retrieved July 27, 2019.
  23. ^ "Trailing commas - JavaScript | MDN". developer.mozilla.org. September 12, 2023. Retrieved December 16, 2023.
  24. ^ "JSON5". json5. Archived from the original on November 29, 2020. Retrieved December 16, 2020.
  25. ^ ECMA-404, 2nd ed., p. iii: "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"
  26. ^ "Media Types". iana.org. Retrieved September 13, 2015.
  27. ^ "Correct Content-Type Header for JSON". ReqBin. January 13, 2023. Retrieved March 23, 2024.
  28. ^ "JSON Schema and Hyper-Schema". json-schema.org. Retrieved June 8, 2021.
  29. ^ "JSON Schema - Specification Links". json-schema.org. Retrieved March 22, 2024.
  30. ^ "JSON Schema Implementations". json-schema.org. Archived from the original on June 16, 2021. Retrieved June 8, 2021.
  31. ^ Bray, Tim (December 2017). Bray, T. (ed.). "11. IANA Considerations". RFC 8259: The JavaScript Object Notation (JSON) Data Interchange Format. IETF. doi:10.17487/RFC8259. S2CID 263868313.
  32. ^ Zyp, Kris (September 16, 2012). Bryan, Paul C. (ed.). "JSON Reference: draft-pbryan-zyp-json-ref-03". Internet Engineering Task Force.
  33. ^ 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.
  34. ^ "JSON: The JavaScript subset that isn't". Magnus Holm. Archived from the original on May 13, 2012. Retrieved May 16, 2011.
  35. ^ "ECMA-262: ECMAScript Language Specification" (5th ed.). December 2009. Archived (PDF) from the original on April 14, 2011. Retrieved March 18, 2011.
  36. ^ "douglascrockford/JSON-js". GitHub. August 13, 2019.
  37. ^ "Denial of Service and Unsafe Object Creation Vulnerability in JSON (CVE-2013-0269)". Retrieved January 5, 2016.
  38. ^ "Microsoft .NET Framework JSON Content Processing Denial of Service Vulnerability". Archived from the original on November 6, 2018. Retrieved January 5, 2016.
  39. ^ "JSON: The Fat-Free Alternative to XML". json.org. Retrieved March 14, 2011.
  40. ^ "Amazon Ion". Amazon. Archived from the original on August 12, 2024. Retrieved August 26, 2024.
  41. ^ "XML 1.1 Specification". World Wide Web Consortium. Retrieved August 26, 2019.
  42. ^ Saternos, Casimir (2014). Client-server web apps with Javascript and Java. "O'Reilly Media, Inc.". p. 45. ISBN 9781449369316.
  43. ^ 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
  44. ^ a b McCombs, Thayne (July 16, 2018). "Why JSON isn't a good configuration language". Lucid Chart. Retrieved June 15, 2019.
  45. ^ "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.
  46. ^ a b "YAML Ain't Markup Language (YAML™) Version 1.2". yaml.org. Retrieved September 13, 2015.
  47. ^ Dohm, Lee (2014). "CoffeeScript Object Notation". The Big Book of Atom. Archived from the original on April 22, 2023. Retrieved April 29, 2024.
  48. ^ "Basic Customization". Atom Flight Manual. GitHub. Archived from the original on April 29, 2024. Retrieved April 29, 2024.
  49. ^ "CSON". Bevry. December 20, 2023. Archived from the original on April 23, 2024. Retrieved April 29, 2024 – via GitHub.
  50. ^ Seonghoon, Kang (July 1, 2021). "CSON". Archived from the original on December 16, 2023. Retrieved February 27, 2023 – via GitHub.
  51. ^ "config/HOCON.md at master · lightbend/config". GitHub. Retrieved August 5, 2021.
  52. ^ "Config File - 2.5.x". www.playframework.com. Retrieved August 5, 2021.
  53. ^ Akka.NET HOCON Docs
  54. ^ "Akka.NET Documentation | Akka.NET Documentation". getakka.net. Retrieved August 5, 2021.
  55. ^ "Managing HOCON configuration files with Puppet". Archived from the original on February 11, 2017. Retrieved March 4, 2023.
  56. ^ "StreamBase Documentation". docs.streambase.com. Retrieved August 5, 2021.
  57. ^ "Configuration Guide". docs.streambase.com. Retrieved August 5, 2021.
  58. ^ "StreamBase New and Noteworthy Archive". docs.streambase.com. Retrieved August 5, 2021.
  59. ^ "Exabeam Advanced Analytics Release Notes". Archived from the original on October 20, 2020. Retrieved March 4, 2023.
  60. ^ JITSI Project. "Config phase 1". GitHub. Retrieved February 16, 2021.
  61. ^ JITSI Project. "reference.conf". GitHub. Retrieved February 16, 2021.
  62. ^ "The JSON5 Data Interchange Format". Retrieved June 25, 2022.
  63. ^ SQLite. "JSON Functions And Operators". Retrieved June 25, 2023.
  64. ^ "JSON with Comments - JSON editing in Visual Studio Code". Visual Studio Code. Microsoft. Retrieved April 29, 2024.
  65. ^ 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.
  66. ^ "GeoJSON". geojson.org. Retrieved August 7, 2022.
  67. ^ "JSON-LD 1.1". World Wide Web Consortium. July 16, 2020. Retrieved June 17, 2022.
  68. ^ "JSON-LD - JSON for Linking Data". json-ld.org. Retrieved August 7, 2022.
  69. ^ "JSON-RPC". jsonrpc.org. Retrieved June 17, 2022.
  70. ^ "JsonML (JSON Markup Language)". JsonML.org. Retrieved June 17, 2022.
  71. ^ McKamey, Stephen (June 14, 2022), JsonML, retrieved August 7, 2022
  72. ^ "FasterXML/smile-format-specification: New home for Smile format". GitHub. Retrieved June 17, 2022.
  73. ^ Gupta, Ayush (February 10, 2019). "Understanding Smile — A data format based on JSON". Code with Ayush. Retrieved August 7, 2022.
  74. ^ "Universal Binary JSON Specification – The universally compatible format specification for Binary JSON". ubjson.org. Retrieved June 17, 2022.
  75. ^ "UBJSON - JSON for Modern C++". json.nlohmann.me. Retrieved August 7, 2022.
[edit]