JSON

Print Print
Reading time 20:27

JavaScript Object Notation
JSON vector logo.svg
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/; also /ˈˌ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 attribute–value pairs and arrays (or other serializable values). It is a very common data format, with a diverse range of applications, one example being web applications that communicate with a server.

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.

Naming and pronunciation

The acronym originated at State Software, a company co-founded by Douglas Crockford and others in March 2001.

The 2017 international standard (ECMA-404 and ISO/IEC 21778:2017) specifies "Pronounced /ˈ.sən/, as in 'Jason and The Argonauts'".[1][2] The first (2013) edition of ECMA-404 did not address the pronunciation.[3] 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."[4] Crockford said in 2011, "There's a lot of argument about how you pronounce that, but I strictly don't care."[5]

Standards

After RFC 4627 had been available as its "informational" specification since 2006, JSON was first standardized in 2013, as ECMA-404.[6]RFC 8259, published in 2017, is the current version of the Internet Standard STD 90, and it remains consistent with ECMA-404.[7] That same year, JSON was also standardized as ISO/IEC 21778:2017.[1] The ECMA and ISO standards describe only the allowed syntax, whereas the RFC covers some security and interoperability considerations.[8]

History

Douglas Crockford at the Yahoo Building. (2007)

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

A precursor to the JSON libraries was used in a children's digital asset trading game project named Cartoon Orbit at Communities.com (at which State Software's co-founders had all worked previously) for Cartoon Network, which used a browser side plug-in with a proprietary messaging format to manipulate Dynamic HTML elements (this system is also owned by 3DO). 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 IE 5+.[citation needed]

Crockford first specified and popularized the JSON format.[10] The State Software co-founders 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 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. Chip Morningstar developed the idea for the State Application Framework at State Software.[11][12]

The system was sold to Sun Microsystems, Amazon.com and EDS. The JSON.org[13] website was launched in 2002. In December 2005, Yahoo! began offering some of its Web services in JSON.[14]

JSON was based on a subset of the JavaScript scripting language (specifically, Standard ECMA-262 3rd Edition—December 1999[15]) 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.[6] 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[1] as an international standard. On 13 December 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.[16][17]

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

Syntax

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

{
  "firstName": "John",
  "lastName": "Smith",
  "isAlive": true,
  "age": 27,
  "address": {
    "streetAddress": "21 2nd Street",
    "city": "New York",
    "state": "NY",
    "postalCode": "10021-3100"
  },
  "phoneNumbers": [
    {
      "type": "home",
      "number": "212 555-1234"
    },
    {
      "type": "office",
      "number": "646 555-4567"
    }
  ],
  "children": [],
  "spouse": null
}

Character encoding

Although Crockford originally asserted and believed that JSON is a strict subset of JavaScript and ECMAScript,[19] 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 does not.[20][21] This is a consequence of JSON disallowing only "control characters". For maximum portability, these characters should be backslash-escaped. This subtlety is important when generating JSONP.[original research?]

JSON exchange in an open ecosystem must be encoded in UTF-8.[7] The encoding supports the full Unicode character set, including those characters outside the Basic Multilingual Plane (U+10000 to U+10FFFF). However, if escaped, those characters must be written using UTF-16 surrogate pairs, a detail missed by some JSON parsers.[original research?] 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.[22][23]

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 a double-precision floating-point format for all its numeric values (until later also supports BigInt[24]), 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. Objects are intended to represent associative arrays,[6] where each key is unique within an object. 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.[25]

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 to expect 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.[26]

Comments were purposefully 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."[25]

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

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.[29] One example of where such an agreement is necessary is the serialization of data types defined by the JavaScript syntax that are not part of the JSON standard, e.g., Date, Function, Regular Expression, and undefined.[30]

Metadata and schema

The official MIME type for JSON text is "application/json",[31] and most modern implementations have adopted this. The unofficial MIME type "text/json" or the content-type "text/javascript" are also supported for legacy reasons by many service providers, browsers, servers, web applications, libraries, frameworks, and APIs. Notable examples include the Google Search API,[32] Yahoo!,[32][33] Flickr,[32] Facebook API,[34]Lift framework,[35] Dojo Toolkit 0.4,[36] etc.

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.[37] 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, currently in 2020-12 draft, which was released on January 28, 2021.[38] There are several validators available for different programming languages,[39] each with varying levels of conformance. There is no standard filename extension, but some have suggested .schema.json.[40]

The JSON standard does not support object references, but an IETF draft standard for JSON-based object references exists.[41] The Dojo Toolkit supports object references using standard JSON; specifically, the dojox.json.ref module provides support for several forms of referencing including circular, multiple, inter-message, and lazy referencing. Internally both do so by assigning a "$ref" key for such references and resolving it at parse-time; the IETF draft only specifies the URL syntax, but Dojo allows more.[42][43][44] Alternatively, non-standard solutions exist such as the use of Mozilla JavaScript Sharp Variables. However this functionality became obsolete with JavaScript 1.8.5 and was removed in Firefox version 12.[45]

Uses

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

Asynchronous JavaScript and JSON (or AJAJ) refers to the same dynamic web page methodology as Ajax, but instead of XML, JSON is the data format. AJAJ is a web development technique that provides for the ability of a webpage 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 webpage. 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.

While JSON is a data serialization format, it has seen ad hoc usage as a configuration language. In this use case, support for comments and other features have been deemed useful, which has led to several nonstandard JSON supersets being created. Among them are HJSON,[46]HOCON, and JSON5 (which despite its name, isn't the fifth version of JSON).[47][48] The primary objective of version 1.2 of YAML was to make the nonstandard format a strict JSON superset.[49]

In 2012, Douglas Crockford 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[50] before handing it to your JSON parser."[25]

JSON is intended as a data serialization format. However, its design as 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.[51] 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,[52] which as of 2017 is supported by all major browsers. For non-supported browsers, an API-compatible JavaScript library is provided by Douglas Crockford.[53] In addition, the TC39 proposal "Subsume JSON" made ECMAScript a strict JSON superset as of the language's 2019 revision.[22][23]

Various JSON parser implementations have suffered from denial-of-service attack and mass assignment vulnerability.[54][55]

Comparison with other 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.[56] Apart from XML, examples could include CSV and YAML (a superset of JSON). Also, Google Protocol Buffers can fill this role, although it is not a data interchange language.

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.[49] YAML supports comments, while JSON does not.[49][47][25]

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 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 !"#$%&'()*+,/;<=>[email protected][\]^`{|}~, 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).[57]

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 strong typing built-in, and has a similar schema concept in JSON Schema.

XML supports comments, while JSON does not.[58][25]

Derivatives

Several serialisation formats have been built on or from the JSON specification. Examples include GeoJSON, JSON-LD, Smile (data interchange format), UBJSON, JSON-RPC, JsonML, and JSON→URL.[59]

See also

  • Comparison of data serialization formats
  • Jackson (API)
  • JSON streaming
  • S-expression

References

  1. ^ a b c "ISO/IEC 21778:2017". ISO. Retrieved July 29, 2019.
  2. ^ "Standard ECMA-404 - The JSON Data Interchange Syntax" (PDF). Ecma International. December 2017. p. 1, footnote. Retrieved October 27, 2019.
  3. ^ ECMA-404: The JSON Data Interchange Format (PDF) (1st ed.). Geneva: ECMA International. October 2013.
  4. ^ 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.
  5. ^ "Douglas Crockford: The JSON Saga - Transcript Vids". transcriptvids.com. Retrieved October 29, 2019.
  6. ^ a b c "The JSON Data Interchange Format" (PDF). ECMA International. October 2013. Retrieved October 24, 2019.
  7. ^ a b "The JavaScript Object Notation (JSON) Data Interchange Format". IETF. December 2017. Retrieved February 16, 2018.
  8. ^ Bray, Tim. "JSON Redux AKA RFC7159". Ongoing. Retrieved March 16, 2014.
  9. ^ "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.
  10. ^ "Douglas Crockford — The JSON Saga". YouTube. August 28, 2011. Retrieved September 23, 2016.
  11. ^ "Chip Morningstar Biography". n.d.
  12. ^ "State Software Breaks Through Web App Development Barrier With State Application Framework: Software Lets Developers Create Truly Interactive Applications; Reduces Costs, Development Time and Improves User Experience". PR Newswire. February 12, 2002. Archived from the original on June 5, 2013. Retrieved March 19, 2013.
  13. ^ "JSON". json.org.
  14. ^ Yahoo!. "Using JSON with Yahoo! Web services". Archived from the original on October 11, 2007. Retrieved July 3, 2009.
  15. ^ 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.
  16. ^ "History for draft-ietf-jsonbis-rfc7159bis-04". IETF Datatracker. Internet Engineering Task Force. Retrieved October 24, 2019. 2017-12-13 [...] RFC published
  17. ^ "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
  18. ^ Apache and the JSON license on LWN.net by Jake Edge (November 30, 2016)
  19. ^ 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.
  20. ^ Holm, Magnus (May 15, 2011). "JSON: The JavaScript subset that isn't". The timeless repository. Retrieved September 23, 2016.
  21. ^ "TC39 Proposal: Subsume JSON". ECMA TC39 committee. May 22, 2018.
  22. ^ a b "Subsume JSON: Proposal to make all JSON text valid ECMA-262". Ecma TC39. August 23, 2019. Retrieved August 27, 2019.
  23. ^ a b "Advance to Stage 4 - tc39/proposal-json-superset". GitHub. May 22, 2018.
  24. ^ "BigInt - MDN Web doc glossary". Mozilla. Retrieved October 18, 2020.
  25. ^ 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.
  26. ^ Andrysco, Marc; Jhala, Ranjit; Lerner, Sorin. "Printing Floating-Point Numbers - An Always Correct Method" (PDF). Retrieved July 27, 2019.
  27. ^ The JSON Data Interchange Syntax (PDF) (2nd ed.). Ecma International. December 2017. p. 11. A single comma token separates a value from a following name.CS1 maint: date and year (link)
  28. ^ "JSON5". json5. Archived from the original on November 29, 2020. Retrieved December 16, 2020.
  29. ^ "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
  30. ^ "ECMAScript 2019 Language Specification" (PDF). Ecma International. June 2019. Archived from the original (PDF) on April 12, 2015. Retrieved October 27, 2019.
  31. ^ "Media Types". iana.org. Retrieved September 13, 2015.
  32. ^ a b c "Handle application/json & text/json by benschwarz · Pull Request #2 · mislav/faraday-stack". GitHub. Retrieved September 13, 2015.
  33. ^ "Yahoo!, JavaScript, and JSON". ProgrammableWeb. December 16, 2005. Retrieved September 13, 2015.
  34. ^ "Make JSON requests allow text/javascript content by jakeboxer · Pull Request #148 · AFNetworking/AFNetworking". GitHub. Retrieved September 13, 2015.
  35. ^ "lift/Req.scala at master · lift/lift · GitHub". GitHub. Retrieved September 13, 2015.
  36. ^ "BrowserIO.js in legacy/branches/0.4/src/io – Dojo Toolkit". dojotoolkit.org. Archived from the original on January 10, 2016. Retrieved September 13, 2015.
  37. ^ "JSON Schema and Hyper-Schema". json-schema.org. Retrieved June 8, 2021.
  38. ^ "draft-handrews-json-schema-00 - JSON Schema: A Media Type for Describing JSON Documents". json-schema.org/. January 28, 2021. Retrieved June 8, 2021.
  39. ^ "JSON Schema Implementations". json-schema.org. Retrieved June 8, 2021.
  40. ^ "Json Schema file extension". Stack Overflow.
  41. ^ Zyp, Kris (September 16, 2012). Bryan, Paul C. (ed.). "JSON Reference: draft-pbryan-zyp-json-ref-03". Internet Engineering Task Force.
  42. ^ Zyp, Kris. "dojox.json.ref". Dojo.
  43. ^ Zyp, Kris (June 17, 2008). "JSON referencing in Dojo". SitePen. Retrieved July 3, 2009.
  44. ^ von Gaza, Tys (December 7, 2010). "JSON referencing in jQuery". NUBUNTU. Archived from the original on May 7, 2015. Retrieved December 7, 2010.
  45. ^ "Sharp variables in JavaScript". Mozilla Developer Network. April 4, 2015. Retrieved April 21, 2012.
  46. ^ 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
  47. ^ a b McCombs, Thayne. "Why JSON isn't a good configuration language". Lucid Chart. Retrieved June 15, 2019.
  48. ^ "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.
  49. ^ a b c "YAML Ain't Markup Language (YAML™) Version 1.2". yaml.org. Retrieved September 13, 2015.
  50. ^ 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.
  51. ^ "JSON: The JavaScript subset that isn't". Magnus Holm. Retrieved May 16, 2011.
  52. ^ "ECMAScript Fifth Edition" (PDF). Archived from the original (PDF) on April 14, 2011. Retrieved March 18, 2011.
  53. ^ "douglascrockford/JSON-js". GitHub. August 13, 2019.
  54. ^ "Denial of Service and Unsafe Object Creation Vulnerability in JSON (CVE-2013-0269)". Retrieved January 5, 2016.
  55. ^ "Microsoft .NET Framework JSON Content Processing Denial of Service Vulnerability". Retrieved January 5, 2016.
  56. ^ "JSON: The Fat-Free Alternative to XML". json.org. Retrieved March 14, 2011.
  57. ^ "XML 1.1 Specification". World Wide Web Consortium. Retrieved August 26, 2019.
  58. ^ Saternos, Casimir (2014). Client-server web apps with Javascript and Java. p. 45. ISBN 9781449369316.
  59. ^ "JSON→URL Specification". Ongoing. Retrieved April 9, 2021.

External links

By: Wikipedia.org
Edited: 2021-06-18 12:29:31
Source: Wikipedia.org