This document is also available in this non-normative format: diff to previous version
Copyright © 2010-2012 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C liability, trademark and document use rules apply.
JSON has proven to be a highly useful object serialization and messaging format. In an attempt to harmonize the representation of Linked Data in JSON, this specification outlines a common JSON representation format for expressing directed graphs; mixing both Linked Data and non-Linked Data in a single document.
This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at http://www.w3.org/TR/.
This document has been under development for over 20 months in the JSON for Linking Data Community Group. The document has recently been transferred to the RDF Working Group for review, improvement, and publication along the Recommendation track. The specification has undergone significant development, review, and changes during the course of the last 20 months.
There are currently five interoperable implementations of this specification. There is a fairly complete test suite and a live JSON-LD editor that is capable of demonstrating the features described in this document. While development on implementations, the test suite and the live editor will continue, they are believed to be mature enough to be integrated into a non-production system at this point in time with the expectation that they could be used in a production system within the next year.
There are a number of ways that one may participate in the development of this specification:
This document was published by the RDF Working Group as an Editor's Draft. If you wish to make comments regarding this document, please send them to public-rdf-comments@w3.org (subscribe, archives). All feedback is welcome.
Publication as an Editor's Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.
This document was produced by a group operating under the 5 February 2004 W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.
This section is non-normative.
JSON, as specified in [RFC4627], is a simple language for representing data on the Web. Linked Data is a technique for creating a network of inter-connected data across different Web documents and Web sites. A document in this data network is typically identified using an IRI (Internationalized Resource Identifier). A software program can typically follow an IRI just like you follow a URL by putting it into your browser's location bar. By following IRIs, a software program can find more information about the document and the things that the document describes. These things may also be identified using IRIs. The IRI allows a software program to start at one document and follow links to other documents or things in order to learn more about all of the documents and things described on the Web.
JSON-LD is designed as a lightweight syntax that can be used to express Linked Data. It is primarily intended to be a way to use Linked Data in Javascript and other Web-based programming environments. It is also useful when building inter-operable Web services and when storing Linked Data in JSON-based document storage engines. It is practical and designed to be as simple as possible, utilizing the large number of JSON parsers and libraries available today.
The syntax does not necessarily require applications to change their JSON, but allows one to easily add meaning by simply adding or referencing a context. The syntax is designed to not disturb already deployed systems running on JSON, but provide a smooth upgrade path from JSON to JSON-LD. Finally, the format is intended to be easy to parse, efficient to generate, and can operate inside of devices that contain very little memory.
This section is non-normative.
This document is a detailed specification for a serialization of Linked Data in JSON. The document is primarily intended for the following audiences:
This specification does not describe the programming interfaces for the JSON-LD Syntax. The specification that describes the programming interfaces for JSON-LD documents is the JSON-LD Application Programming Interface [JSON-LD-API].
To understand the basics in this specification you must first be familiar with JSON, which is detailed in [RFC4627].
This section is non-normative.
A number of design goals were established before the creation of this markup language:
@context
and @id
) to use the basic functionality in JSON-LD.JSON-LD is designed to ensure that Linked Data concepts can be marked up in a way that is simple to understand and create by Web authors. In many cases, regular JSON markup can become Linked Data with the simple addition of a context. As more JSON-LD features are used, more semantics are added to the JSON markup.
JSON provides a number of benefits to software developers that need to serialize data:
JSON has become a very popular data-interchange format on the Web, particularly for REST-based Web Services. Unfortunately, it has a number of short-comings that other Web-native data formats do not have:
JSON-LD is a web-native standard, is 100% compatible with JSON, provides all of the facilities that JSON provides, and extends the language to provide the following core advantages:
Developers that require any of the facilities listed above will find JSON-LD of interest.
Linked Data is a way of publishing data on the Web. In general, Linked Data has four properties; 1) It uses IRIs to name things, 2) It uses HTTP IRIs for those names, 3) The name links, when followed, provide more information about the name, and 4) The data expresses links to data on other Web sites. These properties allow data published on the Web to work much like Web pages do today. One can start at one piece of Linked Data, and follow the links to other pieces of data that are hosted on different sites across the Web.
JSON-LD is a way of expressing Linked Data on the Web. The JSON-LD data model encapsulates the following concepts:
A Linked Data document does not necessarily need to be expressed in JSON-LD. The notion of Linked Data is a concept independent of any given serialization format.
Figure 1: An example of a linked data graph.
There are a number of best practices that can ensure that developers will generate good Linked Data for the Web. JSON-LD formalizes those techniques by providing a mechanism to map JSON data, i.e., keys and values, to IRIs. This does not mean that JSON-LD requires every key or value to be an IRI, but rather ensures that keys and values can be mapped to IRIs if the developer desires to transform their data into Linked Data.
The following is an explanation of the general terminology used in this document. Many of the terms should be familiar to developers that have used JSON:
@value
,
@list
or @set
and it has one or more keys other
than @id
. A node definition may be spread among different
parts of a document or even between different documents.@id
.JSON-LD specifies a number of syntax tokens and keywords that are a core part of the language:
@context
@context
keyword is described in detail in the section titled
3.5 The Context.@graph
@id
@value
@language
@type
@container
@list
@set
@vocab
:
For the avoidance of doubt, all keys, keywords, and values in JSON-LD are case-sensitive.
In JSON-LD, a context is used to map terms, i.e., properties with associated
values in an JSON document, to IRIs. A term is a short word that expands to an
IRI. Terms may be defined as any valid JSON string other
than a JSON-LD keyword. To avoid
forward-compatibility issues, terms starting with an @
character should not be used
as they might be used as keywords in future versions of JSON-LD. Furthermore,
the use of empty terms (""
) is discouraged as not all programming languages are able to handle
empty property names.
The Web uses IRIs for unambiguous identification. The
idea is that these terms mean something that may be of use to other developers and that it is useful to
give them an unambiguous identifier. That is, it is useful for terms to expand to IRIs so that
developers don't accidentally step on each other's vocabulary terms and other resources. Furthermore, developers, and
machines, are able to use this IRI (by plugging it directly into a web browser, for instance) to go to
the term and get a definition of what the term means. This mechanism is analogous to the way we can use
WordNet today to see the definition of words in the English language.
Developers and machines need the same sort of definition of terms. IRIs provide a way to
ensure that these terms are unambiguous. For example, the term name
may
map directly to the IRI http://xmlns.com/foaf/0.1/name
. This allows JSON-LD documents to be constructed
using the common JSON practice of simple key-value pairs while ensuring that the data is useful outside of the
page, API or database in which it resides. The value of a term mapping
must be either; 1) a simple string with the lexical form of an absolute IRI or
2) compact IRI, or 3) an JSON object containing an
@id
, @type
, @language
, or @container
keyword
(all other keywords are ignored by a JSON-LD processor).
These Linked Data terms are typically collected in a context document that would look something like this:
{ "@context": { "name": "http://xmlns.com/foaf/0.1/name", "depiction": { "@id": "http://xmlns.com/foaf/0.1/depiction", "@type": "@id" }, "homepage": { "@id": "http://xmlns.com/foaf/0.1/homepage", "@type": "@id" }, } }
Let's assume that a developer starts with the following JSON document:
{ "name": "Manu Sporny", "homepage": "http://manu.sporny.org/", "depiction": "http://twitter.com/account/profile_image/manusporny" }
The developer can add a single line to the JSON document above to reference the context and transform it into a JSON-LD document:
{
"@context": "http://json-ld.org/contexts/person.jsonld",
"name": "Manu Sporny",
"homepage": "http://manu.sporny.org/",
"depiction": "http://twitter.com/account/profile_image/manusporny"
}
The additions above transform the previous JSON document into a JSON document
with added semantics because the @context
specifies how the
name, homepage, and depiction
terms map to IRIs.
Mapping those keys to IRIs gives the data global context. If two
developers use the same IRI to describe a property, they are more than likely
expressing the same concept. This allows both developers to re-use each others'
data without having to agree to how their data will interoperate on a
site-by-site basis. Contexts may also contain type information
for certain terms as well as other processing instructions for
the JSON-LD processor.
External JSON-LD context documents may contain extra information
located outside of the @context
key, such as documentation about the
terms declared in the document. When importing a
@context
value from an external JSON-LD context document, any extra
information contained outside of the @context
value must be discarded.
Contexts may be specified in-line. This ensures that JSON-LD documents can be processed when a JSON-LD processor does not have access to the Web.
{
"@context":
{
"name": "http://xmlns.com/foaf/0.1/name",
"depiction":
{
"@id": "http://xmlns.com/foaf/0.1/depiction",
"@type": "@id"
},
"homepage":
{
"@id": "http://xmlns.com/foaf/0.1/homepage",
"@type": "@id"
},
},
"name": "Manu Sporny",
"homepage": "http://manu.sporny.org/",
"depiction": "http://twitter.com/account/profile_image/manusporny"
}
Contexts may be used at any time a node definition is defined. A node definition may specify multiple contexts, using an array, which is processed in order. This is useful when an author would like to use an existing context and add application-specific terms to the existing context. Duplicate context terms must be overridden using a last-defined-overrides mechanism.
{ "@context": { "name": "http://example.com/person#name", "details": "http://example.com/person#details" }, "name": "Markus Lanthaler", ... "details": { "@context": { "name": "http://example.com/organization#name" }, "name": "Graz University of Technology" } }
In the example above, the name
prefix is overridden in the
more deeply nested details
structure. Note that this is
rarely a good authoring practice and is typically used when there exist
legacy applications that depend on the specific structure of the
JSON object.
If a term is re-defined within a context, all previous
rules associated with the previous definition are removed. A term defined
in a previous context must be removed, if it is re-defined to null
.
The set of contexts defined within a specific node definition are
referred to as local contexts. Setting the context to null
effectively resets the active context to an empty context. The
active context refers to the accumulation of local contexts
that are in scope at a specific point within the document. The following example
specifies an external context and then layers a local context on top of the external
context:
{ "@context": [ "http://json-ld.org/contexts/person.jsonld", { "pic": "http://xmlns.com/foaf/0.1/depiction" } ], "name": "Manu Sporny", "homepage": "http://manu.sporny.org/", "pic": "http://twitter.com/account/profile_image/manusporny" }
To ensure the best possible performance, it is a best practice to put the context definition at the top of the JSON-LD document. If it isn't listed first, processors have to save each key-value pair until the context is processed. This creates a memory and complexity burden for certain types of low-memory footprint JSON-LD processors.
The null
value is processed in a special way
in JSON-LD. Unless otherwise specified, a JSON-LD processor must act as if a
key-value pair in the body of a JSON-LD document was never declared when
the value equals null. If @value
, @list
,
or @set
is set to null in expanded form, then the
entire JSON object is ignored. If @context
is set
to null, the active context is reset and when used
within a context, it removes any definition associated with
the key, unless otherwise specified.
If a set of terms such as, name, homepage, and depiction, are defined in a context, and that context is used to resolve the names in JSON objects, machines are able to automatically expand the terms to something meaningful and unambiguous, like this:
{ "http://xmlns.com/foaf/0.1/name": "Manu Sporny", "http://xmlns.com/foaf/0.1/homepage": "http://manu.sporny.org" "http://xmlns.com/foaf/0.1/depiction": "http://twitter.com/account/profile_image/manusporny" }
Doing this allows JSON to be unambiguously machine-readable without requiring developers to drastically change their workflow.
The example above does not use the @id
keyword
to identify the node being described above. This type of node is called an
unlabeled node. It is advised that all nodes described in JSON-LD are
given unique identifiers via the @id
keyword unless the data is not
intended to be linked to from other data sets.
A JSON object used to define property values is called a
node definition. Node definitions
do not require an @id
.
Node definitions that do not
contain an @id
are known as an unlabeled nodes.
IRIs are fundamental to Linked Data as that is how most nodess and all properties are identified. IRIs can be expressed in a variety of different ways in JSON-LD.
An IRI (an Internationalized Resource Identifier) is described in [RFC3987]) and the use with JSON-LD conforms to the definition of IRI in [RDF-CONCEPTS].
@id
or @type
.@id
.IRIs may be represented as an absolute IRI, a relative IRI, a term,
a compact IRI, or as a value relative to @vocab
.
An absolute IRI is defined in [RFC3987] containing a scheme along with path and optional query and fragment segments. A relative IRI is an IRI that is relative to some other absolute IRI. In JSON-LD all relative IRIs are resolved relative to the base IRI associated with the document (typically, the directory that contains the document or the document itself).
IRIs can be expressed directly in the key position like so:
{
...
"http://xmlns.com/foaf/0.1/name": "Manu Sporny",
...
}
In the example above, the key http://xmlns.com/foaf/0.1/name
is interpreted
as an IRI because it contains a colon
(:
) and the 'http' prefix does not exist in
the context.
Term expansion occurs for IRIs if the value matches a term defined within the active context:
{ "@context": { "name": "http://xmlns.com/foaf/0.1/name" ... }, "name": "Manu Sporny", "status": "trollin'", ... }
Terms are case sensitive, and must be matched using a case-sensitive comparison.
JSON keys that do not expand to an absolute IRI are ignored, or removed in some cases, by the [JSON-LD-API]. However, JSON keys that do not include a mapping in the context are still considered valid expressions in JSON-LD documents - the keys just don't have any machine-readable, semantic meaning.
Prefixes are expanded when the form of the value is a
compact IRI represented as a prefix:suffix
combination, and the prefix matches a term defined within the
active context:
{ "@context": { "foaf": "http://xmlns.com/foaf/0.1/" ... }, "foaf:name": "Manu Sporny", ... }
foaf:name
above will automatically expand out to the IRI
http://xmlns.com/foaf/0.1/name
. See 4.1 Compact IRIs for more details.
If the @vocab
is set, all keys that do not match a term or a prefix
are
It is often common that all types and properties come from the same vocabulary. JSON-LD's
@vocab
keyword allows to set a base IRI to be used for all properties and types
that that do not match a term, a prefix, or an absolute IRI
(i.e., do not contain a colon). The @vocab
mapping must have a value of a simple string with the
lexical form of an absolute IRI.
{ "@context": { "@vocab": "http://xmlns.com/foaf/1.0/" }, "@type": "Person", "name": "Manu Sporny", }
An IRI is generated when a JSON object is used in the
value position that contains an @id
keyword:
{
...
"homepage": { "@id": "http://manu.sporny.org" }
...
}
Specifying a JSON object with an
@id
key is used to identify that node using an
IRI. When the object has only the @id
, it
is called a node reference.
This facility may also be used to link to another
node definition using a mechanism called
embedding, which is covered in the section titled
4.10 Embedding.
If type coercion rules are specified in the @context
for
a particular term or property IRI, an IRI is generated:
{
"@context":
{
...
"homepage":
{
"@id": "http://xmlns.com/foaf/0.1/homepage",
"@type": "@id"
}
...
}
...
"homepage": "http://manu.sporny.org/",
...
}
In the example above, even though the value
http://manu.sporny.org/
is expressed as a JSON
string, the type coercion rules will transform
the value into an IRI when processed by a JSON-LD Processor.
To be able to externally reference nodes in a graph, it is important that each node has an unambiguous identifier. IRIs are a fundamental concept of Linked Data, and nodes should have a de-referencable identifier used to name and locate them. For nodes to be truly linked, de-referencing the identifier should result in a representation of that node (for example, using a URL to retrieve a web page). Associating an IRI with a node tells an application that the returned document contains a description of the node requested.
JSON-LD documents may also contain descriptions of other nodes, so it is necessary to be able to uniquely identify each node which may be externally referenced.
The node of a JSON object is identified using the @id
keyword:
{ "@context": { ... "homepage": { "@id": "http://xmlns.com/foaf/0.1/homepage", "@type": "@id" } ... }, "@id": "http://example.org/people#joebob", "homepage": "http://manu.sporny.org/", ... }
The example above contains a node identified by the IRI
http://example.org/people#joebob
.
A JSON object used to define property values is called a
node definition. Node definitions
do not require an @id
. A node definition
that does not contain an @id
property defines properties of an
unlabeled node. Node definitions may
be spread among different parts of a document or even between different documents.
To ensure the best possible performance, when possible, it is a best practice
to put JSON-LD keywords, such as @id
and
@context
before other key-value pairs in a JSON object.
However, keys in a JSON object are not ordered,
so processors must not depend on key ordering. If keywords are not listed
first, processors have to save each key-value pair until at least the
@context
and the @id
are processed. Not
specifying those keywords first creates a memory and complexity burden for
low-memory footprint processors, forcing them to use more memory and
computing cycles than necessary.
The type of a particular node can be specified using the @type
keyword. To be considered Linked Data, types must
be uniquely identified by an IRI.
{ ... "@id": "http://example.org/people#joebob", "@type": "http://xmlns.com/foaf/0.1/Person", ... }
A node can be assigned more than one type by using the following markup pattern:
{ ... "@id": "http://example.org/places#BrewEats", "@type": ["http://schema.org/Restaurant", "http://schema.org/Brewery"] ... }
At times, it is important to annotate a string
with its language. In JSON-LD this is possible in a variety of ways.
Firstly, it is possible to define a default language for a JSON-LD document
by setting the @language
key in the @context
or in a
term definition:
{ "@context": { ... "@language": "ja" }, "name": "花澄", "occupation": "科学者" }
The example above would associate the ja
language
code with the two strings 花澄 and 科学者.
Languages must be well-formed language tags according to [BCP47].
It is possible to override the default language by using the expanded form of a value:
{
"@context": {
...
"@language": "ja"
},
"name": "花澄",
"occupation": {
"@value": "Scientist",
"@language": "en"
}
}
It is also possible to override the default language or specify a plain
value by omitting the @language
tag or setting it to
null
when expressing the expanded value:
{ "@context": { ... "@language": "ja" }, "name": { "@value": "Frank" }, "occupation": { "@value": "Ninja", "@language": "en" }, "speciality": "手裏剣" }
Please note that language associations must only be applied to plain literal strings. That is, typed values or values that are subject to 4.6 Type Coercion won't be language tagged.
To clear the default language for a subtree, @language
can
be set to null
in a local context as follows:
{
"@context": {
...
"@language": "ja"
},
"name": "花澄",
"details": {
"@context": {
"@language": null
},
"occupation": "Ninja"
}
}
JSON-LD allows one to associate language information with terms. See 4.5 Expanded Term Definition for more details.
A JSON-LD document is first, and foremost, a JSON document (as defined in [RFC4627]), and any syntactically correct JSON document must be processed by a conforming JSON-LD processor. However, JSON-LD describes a specific syntax to use for expressing Linked Data. This includes the use of specific keywords, as identified in 3.4 Syntax Tokens and Keywords for expressing node definitions, values, and the context. See A. JSON-LD Grammar for authoring guidelines and a BNF description of JSON-LD.
JSON-LD has a number of features that provide functionality above and beyond the core functionality described above. The following section describes this advanced functionality in more detail.
Terms in Linked Data documents may draw from a number of different vocabularies. At times, declaring every single term that a document uses can require the developer to declare tens, if not hundreds of potential vocabulary terms that are used across an application. This is a concern for at least two reasons: the first is the cognitive load on the developer of remembering all of the terms, and the second is the serialized size of the context if it is specified inline. In order to address these issues, the concept of a compact IRI is introduced.
A compact IRI is a way of expressing an IRI
using a prefix and suffix separated by a colon (:
) which is
similar to the CURIE Syntax
in [RDFA-CORE]. The prefix is a term taken from the
active context and is a short string identifying a
particular IRI in a JSON-LD document.
For example, the prefix foaf
may be used as a short
hand for the Friend-of-a-Friend vocabulary, which is identified using
the IRI http://xmlns.com/foaf/0.1/
. A developer may append
any of the FOAF vocabulary terms to the end of the prefix
to specify a short-hand version of the absolute IRI for the
vocabulary term. For example, foaf:name
would
be expanded out to the IRI http://xmlns.com/foaf/0.1/name
.
Instead of having to remember and type out the entire IRI, the developer
can instead use the prefix in their JSON-LD markup.
Terms are interpreted as compact IRIs if they contain at least one
colon and the first colon is not followed by two slashes (//
, as in
http://example.com
). To generate the full IRI,
the value is first split into a prefix and suffix at the first
occurrence of a colon (:
). If the active context
contains a term mapping for prefix, an IRI is generated by
prepending the mapped prefix to the (possibly empty) suffix
using textual concatenation. If no prefix mapping is defined, the value is interpreted
as an absolute IRI. If the prefix is an underscore
(_
), the IRI remains unchanged. This effectively means that every term
containing a colon will be interpreted by a JSON-LD processor as an IRI.
Consider the following example:
{ "@context": { "dc": "http://purl.org/dc/elements/1.1/", "ex": "http://example.org/vocab#" }, "@id": "http://example.org/library", "@type": "ex:Library", "ex:contains": { "@id": "http://example.org/library/the-republic", "@type": "ex:Book", "dc:creator": "Plato", "dc:title": "The Republic", "ex:contains": { "@id": "http://example.org/library/the-republic#introduction", "@type": "ex:Chapter", "dc:description": "An introductory chapter on The Republic.", "dc:title": "The Introduction" } } }
In this example, two different vocabularies
are referred to using prefixes. Those prefixes are then used as type and
property values using the compact IRI prefix:suffix
notation.
It's also possible to use compact IRIs within the context as shown in the following example:
{ "@context": { "xsd": "http://www.w3.org/2001/XMLSchema#", "foaf": "http://xmlns.com/foaf/0.1/", "foaf:homepage": { "@type": "@id" }, "picture": { "@id": "foaf:depiction", "@type": "@id" } }, "@id": "http://me.markus-lanthaler.com/", "@type": "foaf:Person", "foaf:name": "Markus Lanthaler", "foaf:homepage": "http://www.markus-lanthaler.com/", "picture": "http://twitter.com/account/profile_image/markuslanthaler" }
A value with an associated type, also known as a typed value, is indicated by associating a value with an IRI which indicates the value's type. Typed values may be expressed in JSON-LD in three ways:
@type
keyword when defining
a term within a @context
section.The first example uses the @type
keyword to associate a
type with a particular term in the @context
:
{
"@context":
{
"modified":
{
"@id": "http://purl.org/dc/terms/modified",
"@type": "http://www.w3.org/2001/XMLSchema#dateTime"
}
},
...
"modified": "2010-05-29T14:17:39+02:00",
...
}
The modified key's value above is automatically type coerced to a
datetime value because of the information specified in the
@context
.
The second example uses the expanded form of setting the type information in the body of a JSON-LD document:
{
"@context":
{
"modified":
{
"@id": "http://purl.org/dc/terms/modified"
}
},
...
"modified":
{
"@value": "2010-05-29T14:17:39+02:00",
"@type": "http://www.w3.org/2001/XMLSchema#dateTime"
}
...
}
Both examples above would generate the value
2010-05-29T14:17:39+02:00
with the type
http://www.w3.org/2001/XMLSchema#dateTime
. Note that it is
also possible to use a term or a compact IRI to
express the value of a type.
The @type
keyword is also used to associate a type
with a node. The concept of an node type and
a value type are different. This is similar to object-oriented
programming languages where both scalar and structured types use the same
class inheritance mechanism, even though scalar types and structured types are
inherently different.
{ ... "@id": "http://example.org/posts#TripToWestVirginia", "@type": "http://schema.org/BlogPosting", "modified": { "@value": "2010-05-29T14:17:39+02:00", "@type": "http://www.w3.org/2001/XMLSchema#dateTime" } ... }
The first use of @type
associates a node type
(http://schema.org/BlogPosting
) with the node,
which is expressed using the @id
keyword.
The second use of @type
associates a value type
(http://www.w3.org/2001/XMLSchema#dateTime
) with the
value expressed using the @value
keyword. As a
general rule, when @value
and @type
are used in
the same JSON object, the @type
keyword is expressing a value type.
Otherwise, the @type
keyword is expressing a
node type.
A string with an associated language, also known as a language-tagged string, is indicated by associating a string with an language code as defined in [BCP47]. Language-tagged strings may be expressed in JSON-LD in four ways:
@language
keyword within a @context
section.@language
keyword when defining
a term within a @context
section.@container
keyword with a
value of @language
when defining a term within
a @context
section. This usage pattern is called a
language map.The first example uses the @language
keyword to associate a
type with a particular term in the @context
:
{
"@context":
{
"title":
{
"@id": "http://purl.org/dc/terms/title",
"@language": "en"
}
},
...
"title": "JSON-LD Syntax",
...
}
The modified key's value above is automatically
language coerced to a English value because of the information specified in
the @context
.
The second example uses the expanded form of setting the language information in the body of a JSON-LD document:
{
"@context":
{
"title":
{
"@id": "http://purl.org/dc/terms/title"
}
},
...
"title":
{
"@value": "JSON-LD Syntax",
"@language": "en"
}
...
}
Both examples above would generate the value JSON-LD Syntax
tagged with the language en
; which is the [BCP47] code
for the English language.
Systems that support multiple languages often need to express data values in each language. Typically, such systems also try to ensure that developers have a programatically easy way to navigate the datastructures for the language-specific data. In this case, language maps may be utilized.
{
"@context":
{
"title":
{
"@id": "http://purl.org/dc/terms/title"
"@container": "@language"
}
},
...
"title":
{
"en": "JSON-LD Syntax",
"ru": "JSON-LD Синтаксис",
"ja": "JSON-LDの構文"
}
...
}
In the example above, the title is expressed in three languages; English,
Russian, and Japanese. To access the data above in a programming language
supporting dot-notation accessors for object properties, a developer may
use the property.language
pattern. For example, to access the
Japanese version of the title, a developer would use the following code
snippet: obj.title.ja
.
Ordinary JSON documents can be transformed into JSON-LD documents by referencing
to an external JSON-LD context in an HTTP Link Header. Doing this
allows JSON to be unambiguously machine-readable without requiring developers to
drastically change their workflow and provides an upgrade path for existing
infrastructure without breaking existing clients that rely on the application/json
media type.
In order to use an external context with an ordinary JSON document, an author
must specify an IRI to a valid JSON-LD document in an HTTP Link
Header [RFC5988] using the describedby
link relation.
The referenced document must have a top-level node definition. The
@context
subtree within that object is added to the top-level
node definition of the referencing document. If an array is at the top-level of the
referencing document and its items are node definitions, the @context
subtree is added to all array items. All extra information located outside
of the @context
subtree in the referenced document must be
discarded.
The following example demonstrates the use of an external context with an ordinary JSON document:
GET /ordinary-json-document.json HTTP/1.1 Host: example.com Accept: application/ld+json,application/json,*/*;q=0.1 ==================================== HTTP/1.0 200 OK ... Content-Type: application/json Link: <http://json-ld.org/contexts/person.jsonld>; rel="describedby"; type="application/ld+json" { "name": "Markus Lanthaler", "homepage": "http://www.markus-lanthaler.com/", "depiction": "http://twitter.com/account/profile_image/markuslanthaler" }
JSON-LD documents served with the application/ld+json
media type
must have all context information, including references to external contexts, within the
body of the document.
Within a context definition, terms may be defined using an expanded notation to allow for additional information associated with the term to be specified (see also 4.6 Type Coercion and 4.9 Sets and Lists).
Instead of using a string representation of an IRI, the IRI may be
specified using a JSON object having an @id
key.
The value of the @id
key must be either a term, a
compact IRI, or an absolute IRI. Such
an object is called a node reference.
{ "@context": { "foaf": { "@id": "http://xmlns.com/foaf/0.1/" }, "name": { "@id": "http://xmlns.com/foaf/0.1/name" }, "homepage": { "@id": "foaf:homepage" }, "depiction": { "@id": "foaf:depiction" } }, "name": "Manu Sporny", "homepage": "http://manu.sporny.org/", "depiction": "http://twitter.com/account/profile_image/manusporny" }
This allows additional information to be associated with the term. This may be used for 4.6 Type Coercion, 4.9 Sets and Lists), or to associate language information with a term as shown in the following example:
{ "@context": { ... "ex": "http://example.com/", "@language": "ja", "name": { "@id": "ex:name", "@language": null }, "occupation": { "@id": "ex:occupation" }, "occupation_en": { "@id": "ex:occupation", "@language": "en" }, "occupation_cs": { "@id": "ex:occupation", "@language": "cs" } }, "name": "Yagyū Muneyoshi", "occupation": "忍者", "occupation_en": "Ninja", "occupation_cs": "Nindža", ... }
The example above would associate 忍者 with the specified default
language code ja
, Ninja with the language code
en
, and Nindža with the language code cs
.
The value of name
, Yagyū Muneyoshi wouldn't be
associated with any language code since @language
was reset to
null in the expanded term definition.
Expanded terms may also be defined using compact IRIs or
absolute IRIs as keys. If the definition does not include an
@id
key, the expanded IRI is determined by performing expansion of the key
within the current active context. This mechanism is mainly used to associate type or language
information with a compact IRI or an absolute IRI.
While it is possible to define a
compact IRI, or an absolute IRI to expand to some
other unrelated IRI (for example, foaf:name
expanding to
http://example.org/unrelated#species
),
such usage is strongly discouraged.
JSON-LD supports the coercion of values to particular data types. Type coercion allows someone deploying JSON-LD to coerce the incoming or outgoing values to the proper data type based on a mapping of data type IRIs to terms. Using type coercion, value representation is preserved without requiring the data type to be specified with each piece of data.
Type coercion is specified within an 4.5 Expanded Term Definition
using the @type
key. The value of this key represents a type IRI and must take the form of
a term, compact IRI, absolute IRI, or the keyword @id
. Specifying
@id
indicates that within the body of a JSON-LD document, a string value of a term coerced to
@id
is to be interpreted as an IRI.
Terms or compact IRIs used as the value of a
@type
key may be defined within the same context. This means that one may specify a
term like xsd
and then use xsd:integer
within the same
context definition - the JSON-LD processor will be able to determine the proper expansion for
xsd:integer
.
The example below demonstrates how a JSON-LD author can coerce values to typed values, IRIs and lists.
{ "@context": { "xsd": "http://www.w3.org/2001/XMLSchema#", "name": "http://xmlns.com/foaf/0.1/name", "age": { "@id": "http://xmlns.com/foaf/0.1/age", "@type": "xsd:integer" }, "homepage": { "@id": "http://xmlns.com/foaf/0.1/homepage", "@type": "@id", "@container": "@list" } }, "name": "John Smith", "age": "41", "homepage": [ "http://personal.example.org/", "http://work.example.com/jsmith/" ] }
The example above would generate the following Turtle:
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> . [ foaf:name "John Smith"; foaf:age "41"^^xsd:integer; foaf:homepage ( <http://personal.example.org/> <http://work.example.com/jsmith/> ) ] .
Terms may also be defined using absolute IRIs or compact IRIs. This allows coercion rules to be applied to keys which are not represented as a simple term. For example:
{ "@context": { "foaf": "http://xmlns.com/foaf/0.1/", "foaf:age": { "@type": "xsd:integer" }, "foaf:homepage": { "@type": "@id" } }, "foaf:name": "John Smith", "foaf:age": "41", "foaf:homepage": [ "http://personal.example.org/", "http://work.example.com/jsmith/" ] }
In this case the @id
definition is optional, but if it does exist, the compact IRI
or IRI is treated as a term (not a prefix:suffix
construct)
so that the actual definition of a prefix becomes unnecessary.
Keys in the context are treated as terms for the purpose of
expansion and value coercion. At times, this may result in multiple representations for the same expanded IRI.
For example, one could specify that dog
and cat
both expanded to http://example.com/vocab#animal
.
Doing this could be useful for establishing different type coercion or language specification rules. It also allows a compact IRI (or even an
absolute IRI) to be defined as something else entirely. For example, one could specify that
the term http://example.org/zoo
should expand to
http://example.org/river
, but this usage is discouraged because it would lead to a
great deal of confusion among developers attempting to understand the JSON-LD document.
Type coercion is performed using the unexpanded value of the key, which must have an exact match for an entry in the active context.
At times, an author may find that they need to express the same value for multiple properties. The simplest approach to accomplish this goal would be to do the following:
{ "@context": { "title1": "http://purl.org/dc/terms/title", "title2": "http://schema.org/name", "title3": "http://www.w3.org/2000/01/rdf-schema#label" }, "@id": "http://example.com/book", "title1": "The Count of Monte Cristo", "title2": "The Count of Monte Cristo", "title3": "The Count of Monte Cristo" }
Unfortunately, the approach above produces redundant data and would become a publishing burden for large data sets. In these situations, the author may use a property generator to express a term once, but have the JSON-LD processor expand the single statement into multiple statements. This method can be accomplished by using the following markup pattern:
{ "@context": { "title": { "@id": [ "http://purl.org/dc/terms/title", "http://schema.org/name", "http://www.w3.org/2000/01/rdf-schema#label" ] } }, "@id": "http://example.com/book", "title": "The Count of Monte Cristo" }
While the term above is only used once outside of the @context
,
a JSON-LD processor will internally transform the document above into
the following set of statements:
<http://example.com/book> <http://purl.org/dc/terms/title> "The Count of Monte Cristo" . <http://example.com/book> <http://schema.org/name> "The Count of Monte Cristo" . <http://example.com/book> <http://www.w3.org/2000/01/rdf-schema#label> "The Count of Monte Cristo" .
In general, normal IRI expansion rules apply
anywhere an IRI is expected (see 3.7 IRIs). Within
a context definition, this can mean that terms defined
within the context may also be used within that context as long as
there are no circular dependencies. For example, it is common to use
the xsd
namespace when defining typed values:
{ "@context": { "xsd": "http://www.w3.org/2001/XMLSchema#", "name": "http://xmlns.com/foaf/0.1/name", "age": { "@id": "http://xmlns.com/foaf/0.1/age", "@type": "xsd:integer" }, "homepage": { "@id": "http://xmlns.com/foaf/0.1/homepage", "@type": "@id" } }, ... }
In this example, the xsd
term is defined
and used as a prefix for the @type
coercion
of the age
property.
Terms may also be used when defining the IRI of another term:
{ "@context": { "foaf": "http://xmlns.com/foaf/0.1/", "xsd": "http://www.w3.org/2001/XMLSchema#", "name": "foaf:name", "age": { "@id": "foaf:age", "@type": "xsd:integer" }, "homepage": { "@id": "foaf:homepage", "@type": "@id" } }, ... }
Compact IRIs and IRIs may be used on the left-hand side of a term definition.
{ "@context": { "foaf": "http://xmlns.com/foaf/0.1/", "xsd": "http://www.w3.org/2001/XMLSchema#", "name": "foaf:name", "foaf:age": { "@type": "xsd:integer" }, "foaf:homepage": { "@type": "@id" } }, ... }
In this example, the compact IRI form is used in two different
ways.
In the first approach, foaf:age
declares both the
IRI for the term (using short-form) as well as the
@type
associated with the term. In the second
approach, only the @type
associated with the term is
specified. The JSON-LD processor will derive the full IRI for
foaf:homepage
by looking up the foaf
prefix in the
context.
Absolute IRIs may also be used in the key position in a context:
{
"@context":
{
"foaf": "http://xmlns.com/foaf/0.1/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"name": "foaf:name",
"foaf:age":
{
"@id": "foaf:age",
"@type": "xsd:integer"
},
"http://xmlns.com/foaf/0.1/homepage":
{
"@type": "@id"
}
},
...
}
In order for the absolute IRI to match above, the absolute IRI must also
be used in the JSON-LD document. Also note that foaf:homepage
will not use the { "@type": "@id" }
declaration because
foaf:homepage
is not the same as
http://xmlns.com/foaf/0.1/homepage
. That is, a JSON-LD
processor will use direct string comparison when looking up
terms in a context before it applies the
prefix lookup mechanism.
The only exception for using terms in the context is that they must not be used in a circular manner. That is, a definition of term-1 must not depend on the definition of term-2 if term-2 also depends on term-1. For example, the following context definition is illegal:
{
"@context":
{
"term1": "term2:foo",
"term2": "term1:bar"
},
...
}
A JSON-LD author can express multiple values in a compact way by using arrays. Since graphs do not describe ordering for links between nodes, arrays in JSON-LD do not provide an ordering of the contained elements by default. This is exactly the opposite from regular JSON arrays, which are ordered by default. For example, consider the following simple document:
{
...
"@id": "http://example.org/people#joebob",
"nick": [ "joe", "bob", "jaybee" ],
...
}
The markup shown above would result in the following data being generated, each relating the node to an individual value, with no inherent order:
Subject | Property | Object |
---|---|---|
http://example.org/people#joebob | http://xmlns.com/foaf/0.1/nick | joe |
http://example.org/people#joebob | http://xmlns.com/foaf/0.1/nick | bob |
http://example.org/people#joebob | http://xmlns.com/foaf/0.1/nick | jaybee |
Multiple values may also be expressed using the expanded form:
{
"@id": "http://example.org/articles/8",
"dc:title":
[
{
"@value": "Das Kapital",
"@language": "de"
},
{
"@value": "Capital",
"@language": "en"
}
]
}
The markup shown above would generate the following data, again with no inherent order:
Subject | Property | Object | Language |
---|---|---|---|
http://example.org/articles/8 | http://purl.org/dc/terms/title | Das Kapital | de |
http://example.org/articles/8 | http://purl.org/dc/terms/title | Capital | en |
As the notion of ordered collections is rather important in data
modeling, it is useful to have specific language support. In JSON-LD,
a list may be represented using the @list
keyword as follows:
{
...
"@id": "http://example.org/people#joebob",
"foaf:nick":
{
"@list": [ "joe", "bob", "jaybee" ]
},
...
}
This describes the use of this array as being ordered,
and order is maintained when processing a document. If every use of a given multi-valued
property is a list, this may be abbreviated by setting @container
to @list
in the context:
{ "@context": { ... "nick": { "@id": "http://xmlns.com/foaf/0.1/nick", "@container": "@list" } }, ... "@id": "http://example.org/people#joebob", "nick": [ "joe", "bob", "jaybee" ], ... }
List of lists are not allowed in this version of JSON-LD. If a list of lists is detected, a JSON-LD processor will throw an exception. This decision was made due to the extreme amount of added complexity when processing lists of lists.
Similarly to @list
, there exists the keyword @set
to
describe unordered sets. While its use in the body of a JSON-LD document
represents just syntactic sugar that must be optimized away when processing
the document, it is very helpful when used within the context of a document.
Values of terms associated with a @set
or @list
container
are always represented in the form of an array - even if there is just a
single value that would otherwise be optimized to a non-array form in a
4.15 Compact Document Form. This makes post-processing of
the data easier as the data is always in array form, even if the array only
contains a single value.
The use of @container
in the body of a JSON-LD
document, i.e., outside @context
must be ignored by
JSON-LD processors.
Embedding is a JSON-LD feature that allows an author to use node definitions as property values. This is a commonly used mechanism for creating a parent-child relationship between two nodes.
The example shows two nodes related by a property from the first node:
{ ... "name": "Manu Sporny", "knows": { "@type": "Person", "name": "Gregg Kellogg", } ... }
A node definition, like the one used above, may be used in any value position in the body of a JSON-LD document.
The @graph
keyword is used to express a set of
JSON-LD node definitions that may not be directly related
to one another through a property. The mechanism may also be used where
embedding is not desirable to the application. For example:
{
"@context": ...,
"@graph":
[
{
"@id": "http://manu.sporny.org/i/public",
"@type": "foaf:Person",
"name": "Manu Sporny",
"knows": "http://greggkellogg.net/foaf#me"
},
{
"@id": "http://greggkellogg.net/foaf#me",
"@type": "foaf:Person",
"name": "Gregg Kellogg",
"knows": "http://manu.sporny.org/i/public"
}
]
}
In this case, embedding doesn't work as each
node definition references the other. Using the
@graph
keyword allows multiple resources to be
defined within an array, and allows the use of a shared
context. When used in a JSON object that is not otherwise
a node definition, this describes resources in the default graph.
This is equivalent to using multiple node definitions in array and defining
the @context
within each node definition:
[ { "@context": ..., "@id": "http://manu.sporny.org/i/public", "@type": "foaf:Person", "name": "Manu Sporny", "knows": "http://greggkellogg.net/foaf#me" }, { "@context": ..., "@id": "http://greggkellogg.net/foaf#me", "@type": "foaf:Person", "name": "Gregg Kellogg", "knows": "http://manu.sporny.org/i/public" } ]
JSON-LD allows you to name things on the Web by assigning
an @id
to them, which is typically an IRI.
This notion extends to the ability to identify graphs in the same
manner. A developer may name data expressed using the @graph
keyword by pairing it with an @id
keyword. This enables the developer to make statements
about a linked data graph itself,
rather than just a single node.
{
"@context": {
"asOf": "http://purl.org/net/provenance/ns#accessedResource",
"Person": "http://xmlns.com/foaf/0.1/Person",
"name": "http://xmlns.com/foaf/0.1/name",
"knows": "http://xmlns.com/foaf/0.1/knows",
"xsd": "http://www.w3.org/2001/XMLSchema#"
},
"@id": "http://example.org/graphs/73",
"asOf": { "@value": "2012-04-09", "@type": "xsd:date" },
"@graph":
[
{
"@id": "http://manu.sporny.org/i/public",
"@type": "Person",
"name": "Manu Sporny",
"knows": "http://greggkellogg.net/foaf#me"
},
{
"@id": "http://greggkellogg.net/foaf#me",
"@type": "Person",
"name": "Gregg Kellogg",
"knows": "http://manu.sporny.org/i/public"
}
]
}
The example above expresses a named
linked data graph that is identified by the IRI
http://example.org/graphs/73
. That graph is composed of the
statements about Manu and Gregg. Metadata about the graph itself is also
expressed via the asOf
property, which specifies when the
information was retrieved from the Web. An alternative view of the
information above is represented in table form below:
Graph | Subject | Property | Object | Datatype |
---|---|---|---|---|
http://example.org/graphs/73 | http://example.org/graphs/73 | http://purl.org/net/provenance/ns#accessedResource | 2012-04-09 | http://www.w3.org/2001/XMLSchema#date |
http://example.org/graphs/73 | http://manu.sporny.org/i/public | http://www.w3.org/2001/XMLSchema#type | http://xmlns.com/foaf/0.1/Person | |
http://example.org/graphs/73 | http://manu.sporny.org/i/public | http://xmlns.com/foaf/0.1/name | Manu Sporny | |
http://example.org/graphs/73 | http://manu.sporny.org/i/public | http://xmlns.com/foaf/0.1/knows | http://greggkellogg.net/foaf#me | |
http://example.org/graphs/73 | http://greggkellogg.net/foaf#me | http://www.w3.org/2001/XMLSchema#type | http://xmlns.com/foaf/0.1/Person | |
http://example.org/graphs/73 | http://greggkellogg.net/foaf#me | http://xmlns.com/foaf/0.1/name | Gregg Kellogg | |
http://example.org/graphs/73 | http://greggkellogg.net/foaf#me | http://xmlns.com/foaf/0.1/knows | http://manu.sporny.org/i/public |
At times, it becomes necessary to be able to express information without
being able to specify the node. Typically, this type of node is called
an unlabeled node or a blank node (see [RDF-CONCEPTS] Section 3.4: Blank Nodes).
In JSON-LD, unlabeled node identifiers are
automatically created if a node is not specified using the
@id
keyword. However, authors may provide identifiers for
unlabeled nodes by using the special _
(underscore)
prefix. This allows one to reference the node locally within the
document, but makes it impossible to reference the node from an
external document. The unlabeled node identifier is scoped to the
document in which it is used.
{
...
"@id": "_:foo",
...
}
The example above would set the node to _:foo
, which can
then be used elsewhere in the JSON-LD document to refer back to the
unlabeled node. If a developer finds that they refer to the unlabeled
node more than once, they should consider naming the node using a de-referenceable
IRI so that it can be referenced also from other documents.
Each of the JSON-LD keywords,
except for @context
, may be aliased to application-specific
keywords. This feature allows legacy JSON content to be utilized
by JSON-LD by re-using JSON keys that already exist in legacy documents.
This feature also allows developers to design domain-specific implementations
using only the JSON-LD context.
{ "@context": { "url": "@id", "a": "@type", "name": "http://schema.org/name" }, "url": "http://example.com/about#gregg", "a": "http://schema.org/Person", "name": "Gregg Kellogg" }
In the example above, the @id
and @type
keywords have been given the aliases url and
a, respectively.
The JSON-LD API [JSON-LD-API] defines an method for expanding a
JSON-LD document.
Expansion is the process of taking a JSON-LD document and applying a
@context
such that all IRIs, types, and values
are expanded so that the @context
is no longer necessary.
For example, assume the following JSON-LD input document:
{ "@context": { "name": "http://xmlns.com/foaf/0.1/name", "homepage": { "@id": "http://xmlns.com/foaf/0.1/homepage", "@type": "@id" } }, "name": "Manu Sporny", "homepage": "http://manu.sporny.org/" }
Running the JSON-LD Expansion algorithm against the JSON-LD input document provided above would result in the following output:
[ { "http://xmlns.com/foaf/0.1/name": [ { "@value": "Manu Sporny" } ], "http://xmlns.com/foaf/0.1/homepage": [ { "@id": "http://manu.sporny.org/" } ] } ]
Expanded document form is useful when an application has to process input data in a deterministic form. It has been optimized to ensure that the code that developers have to write is minimized compared to the code that would have to be written to operate on 4.15 Compact Document Form.
The JSON-LD API [JSON-LD-API] defines a method for compacting a JSON-LD document. Compaction is the process of taking a JSON-LD document and applying a context such that the most compact form of the document is generated. JSON is typically expressed in a very compact, key-value format. That is, full IRIs are rarely used as keys. At times, a JSON-LD document may be received that is not in its most compact form. JSON-LD, via the API, provides a way to compact a JSON-LD document.
For example, assume the following JSON-LD input document:
[ { "http://xmlns.com/foaf/0.1/name": [ "Manu Sporny" ], "http://xmlns.com/foaf/0.1/homepage": [ { "@id": "http://manu.sporny.org/" } ] } ]
Additionally, assume the following developer-supplied JSON-LD context:
{ "@context": { "name": "http://xmlns.com/foaf/0.1/name", "homepage": { "@id": "http://xmlns.com/foaf/0.1/homepage", "@type": "@id" } } }
Running the JSON-LD Compaction algorithm given the context supplied above against the JSON-LD input document provided above would result in the following output:
{ "@context": { "name": "http://xmlns.com/foaf/0.1/name", "homepage": { "@id": "http://xmlns.com/foaf/0.1/homepage", "@type": "@id" } }, "name": "Manu Sporny", "homepage": "http://manu.sporny.org/" }
The compaction algorithm enables a developer to map any document into an
application-specific compacted form by first 4.14 Expanded Document Form.
While the context provided above mapped http://xmlns.com/foaf/0.1/name
to name, it could have also mapped it to any arbitrary string
provided by the developer. This powerful mechanism, along with another
JSON-LD API technique called framing, allows the developer to
re-shape the incoming JSON data into a format that is optimized for
their application.
This section is an attempt to formalize a normative grammar for JSON-LD.
This appendix restates the syntactic conventions described in the previous sections more formally.
A JSON-LD processor should attempt to process non-conforming JSON-LD documents. Conformance violations must be reported through a conformance violation callback mechanism defined in the [JSON-LD-API].
For a JSON-LD document to be conforming, it must be a valid JSON document as described in [RFC4627].
JSON-LD introduces a number of keywords of the form '@
'
followed by a set of one or more lower case alphabetic characters
(@[a-z]+
). JSON-LD documents should not define terms beginning
with '@
'.
(See 3.4 Syntax Tokens and Keywords for a complete definition of JSON-LD keywords).
The JSON-LD context allows keywords to be
aliased within the active context. Whenever a keyword is
discussed, this is also understood to apply to an alias for that keyword
For example, if the active context defines the term id
as
an alias for @id
, that alias may be legitimately used as a substitution
for @id
. Note that keyword aliases are not expanded during
context processing.
A JSON-LD document is either a a single node definition or a JSON array containing a set of one or more node definitions.
{ "name": "Manu Sporny", "homepage": "http://manu.sporny.org/", "depiction": "http://twitter.com/account/profile_image/manusporny" }
[ { "name": "Manu Sporny", "homepage": "http://manu.sporny.org/", "depiction": "http://twitter.com/account/profile_image/manusporny" }, { "name": "Gregg Kellogg", "homepage": "http://greggkellogg.net/", "depiction": "http://twitter.com/account/profile_image/gkellogg" } ]
A node definition is a JSON object containing one or more key-value pairs. Keys are IRIs, compact IRIs, terms defined within the active context, or one of the following keywords:
@context
,@graph
,@id
, or@type
If the node definition contains the @context
key, its value must be one of the following:
{
"@context": "http://json-ld.org/contexts/person.jsonld",
"name": "Manu Sporny",
"homepage": "http://manu.sporny.org/",
"depiction": "http://twitter.com/account/profile_image/manusporny"
}
See 3.8 Node Identifiers, 4.1 Compact IRIs,
and 4.12 Identifying Unlabeled Nodes for further discussion on
@id
values.
If the node definition contains the @id
key, it's value
must be a string having the lexical form of IRI,
compact IRI (including unlabeled node), or a
term defined in the active context expanding
into an IRI or an unlabeled node.
{
"@context": "http://json-ld.org/contexts/person.jsonld",
"@id": "http://manu.sporny.org/i/public",
"name": "Manu Sporny",
"homepage": "http://manu.sporny.org/",
"depiction": "http://twitter.com/account/profile_image/manusporny"
}
If the node definition contains the @type
key, it's value
must be either a string having the lexical form of
absolute IRI, compact IRI, a term defined in the
active context expanding into an absolute IRI,
or an array of any of these.
A JSON-LD processor should process non-conforming documents
having @type
values including node definition or
node reference entries but must
discard everything except for the value of the @id
key.
{
"@context": "http://json-ld.org/contexts/person.jsonld",
"@id": "http://manu.sporny.org/i/public",
"@type": "Person",
"name": "Manu Sporny",
"homepage": "http://manu.sporny.org/",
"depiction": "http://twitter.com/account/profile_image/manusporny"
}
See 3.9 Specifying the Type for further discussion on
@type
values.
If the node definition contains the @graph
key, it's value must
be a node definition or an array of zero or more
node definitions. If the
node definition contains an @id
keyword,
its value is used as the label of a named graph.
As a special case, if the JSON object contains no
keys other than @graph
and @context
, and the
JSON object is the root of the JSON-LD document, the
JSON object is not treated as a node definition; this
is used as a way of defining node
definitions that may not form a connected graph. This allows a
context to be defined which is shared by all of the constituent
node definitions.
{
"@context": ...,
"@graph":
[
{
"@id": "http://manu.sporny.org/i/public",
"@type": "foaf:Person",
"name": "Manu Sporny",
"knows": "http://greggkellogg.net/foaf#me"
},
{
"@id": "http://greggkellogg.net/foaf#me",
"@type": "foaf:Person",
"name": "Gregg Kellogg",
"knows": "http://manu.sporny.org/i/public"
}
]
}
See 4.11 Named Graphs for further discussion on
@graph
values.
A JSON-LD document must not contain any keyword or alias that expands to another keyword.
Other keys must expand to an absolute IRI using the active context. The values associated with these keys may be any of the following:
@set
or @list
definition (see 4.9 Sets and Lists),A JSON object containing only the @id
(or an alias for @id
) is a node reference and not a
node definition.
{ "@context": ..., "@graph": [ { "@id": "http://example.org/library", "@type": "ex:Library", "ex:contains": {"@id": "http://example.org/library/the-republic"} }, { "@id": "http://example.org/library/the-republic", "@type": "ex:Book", "dc:creator": "Plato", "dc:title": "The Republic", "ex:contains": {"@id": "http://example.org/library/the-republic#introduction"} }, { "@id": "http://example.org/library/the-republic#introduction", "@type": "ex:Chapter", "dc:description": "An introductory chapter on The Republic.", "dc:title": "The Introduction" } ] } }
A language map may be used as a term value within a
node definition if the term is defined with
@container
set to @language
.
The keys of a language map must be a [BCP47] string with an associated value that is any of the following types:
@set
or @list
definition (see 4.9 Sets and Lists), orWe had also discussed values other than strings, such as those that might represent a more reified version of a value with other properties, such as is described using SKOS-XL.
{ "@context": { "title": { "@id": "http://purl.org/dc/terms/title" "@container": "@language" } }, ... "title": { "en": "JSON-LD Syntax", "ru": "JSON-LD Синтаксис", "ja": "JSON-LDの構文" } ... }
An expanded value is a JSON object containing the
@value
key, or an alias for the @value
value key.
It may
also contain the @type
or @language
keys, or their
respective keyword aliases. An expanded value must not
contain keys other than @value
, @language
, and
@type
.
An expanded value must not contain both the
@language
and @type
keys.
The value of the @value
key, or its alias, must be either a
string, number, true, or
false.
If an expanded value contains a @language
key,
it must not contain any other key except @value
. The value of
the @language
key must have the lexical form described in
[BCP47], or be null.
If an expanded value contains a @type
key, it
must not contain any other key except @value
. The value of
@type
must be a term, compact IRI,
absolute IRI, or null
.
See 4.2 Typed Values and 4.3 Language-tagged Strings for a further discussion of expanded values.
A list is a JSON object having only the @list
keyword. Its value must be an array of any of the following:
A set is a JSON object having only the @set
keyword. Its value must be an array of any of the following:
@set
or @list
definition (see 4.9 Sets and Lists), orSee 4.9 Sets and Lists for a further discussion of List and Set Values.
A context definition is a JSON object
containing one or more key-value pairs. Keys are non-keyword strings
or the @language
or @vocab
keywords.
A context definition
should not contain any keys having the lexical form of keyword other than
@language
or @vocab
.
If the context definition has a @language
key,
the value must have the lexical form described in [BCP47] or be null.
If the context definition has a @vocab
key,
the value must have the lexical form of absolute IRI or be null.
Other keys are term definitions. Their values must be either a string, or a JSON object having the form of an expanded term definition (see 4.5 Expanded Term Definition).
An expanded term definition is composed of zero or more keys from @id
,
@type
, @language
or @container
. An
expanded term definition should not contain any other keys.
All values associated with @id
must expand to an absolute IRI.
If the term definition is not a compact IRI or absolute IRI,
the expanded term
definition must include the @id
key.
If the expanded term definition contains the @id
keyword,
it must be a string having the lexical form of IRI,
compact IRI, a term defined in the defining context
definition or the active context, or an array composed of any of the previous allowed values.
If the expanded term definition contains the @type
keyword,
it must be a string having the lexical form of absolute IRI,
compact IRI, or a term defined in the defining context
definition or the active context.
If the expanded term definition contains the @language
keyword,
the value must have the lexical form described in [BCP47] or be null.
If the expanded term definition contains the @container
keyword,
the value must be either @list
, @set
, @language
, or be null.
If the value is @language
, when the term is used outside of the @context
, the
associated value must be a JSON object whose keys are strings that are [BCP47] language identifiers.
The values associated with each [BCP47] language string must be a string or an array of strings.
See 3.5 The Context and 4.5 Expanded Term Definition for a further discussion of contexts.
{ "@language": "en", "xsd": "http://www.w3.org/2001/XMLSchema#", "foaf": "http://xmlns.com/foaf/0.1/", "name": "foaf:name", "depiction": {"@id": "foaf:depiction", "@type": "@id"}, "modified": {"@id": "http://purl.org/dc/terms/modified", "@type": "xsd:dateTime"}, "homepage": {"@id": "foaf:homepage", "@type": "@id", "@container": "@list"} }
This section is non-normative.
The intent of the Working Group and the Editors of this specification is to eventually align terminology used in this document with the terminology used in the RDF Concepts document [RDF-CONCEPTS] to the extent to which it makes sense to do so. In general, if there is an analogue to terminology used in this document in the RDF Concepts document, the preference is to use the terminology in the RDF Concepts document.
JSON-LD is a specification for representing Linked Data in JSON. A common
way of working with Linked Data is through RDF, the Resource Description Framework.
RDF can be expressed using JSON-LD by associating JSON-LD concepts such as @id
and @type
with the equivalent IRIs in RDF. Further information about
RDF may be found in the [RDF-PRIMER].
The JSON-LD markup examples below demonstrate how JSON-LD can be used to express semantic data marked up in other languages and data models such as RDF, Turtle, RDFa, Microformats, and Microdata. These sections are merely provided as evidence that JSON-LD is very flexible in what it can express across different Linked Data approaches. Further information on transforming JSON-LD into RDF are detailed in the [JSON-LD-API].
This section is non-normative.
The RDF data model, as outlined in [RDF-CONCEPTS], is an abstract syntax for representing a directed graph of information. JSON-LD is capable of serializing any RDF graph, and performing full RDF to JSON-LD to RDF round-tripping. A complete description of how JSON-LD maps to RDF and algorithms detailing how one can convert from RDF to JSON-LD and from JSON-LD to RDF are included in the JSON-LD API [JSON-LD-API] specification.
JSON-LD allows properties to be BNodes, while RDF does not. Expressing properties as BNodes in JSON-LD only becomes an issue (and could raise an exception) when it is transformed to RDF.
Note that the JSON-LD data model is silent on the topic of unlabeled nodes. Nevertheless, this specification allows for the expression of unlabeled nodes, as most graph-based data sets on the Web contain a number of associated nodes that are not named and thus are not directly de-referenceable.
This section is non-normative.
The following are examples of converting RDF expressed in [TURTLE-TR] into JSON-LD.
This section is non-normative.
The JSON-LD context has direct equivalents for the Turtle
@prefix
declaration:
@prefix foaf: <http://xmlns.com/foaf/0.1/> . <http://manu.sporny.org/i/public> a foaf:Person; foaf:name "Manu Sporny"; foaf:homepage <http://manu.sporny.org/> .
{ "@context": { "foaf": "http://xmlns.com/foaf/0.1/" }, "@id": "http://manu.sporny.org/i/public", "@type": "foaf:Person", "foaf:name": "Manu Sporny", "foaf:homepage": { "@id": "http://manu.sporny.org/" } }
JSON-LD has no equivalent for the Turtle @base
declaration.
Both Turtle and JSON-LD allow embedding, although Turtle only allows embedding of unlabeled nodes.
@prefix foaf: <http://xmlns.com/foaf/0.1/> . <http://manu.sporny.org/i/public> a foaf:Person; foaf:name "Manu Sporny"; foaf:knows [ a foaf:Person; foaf:name "Gregg Kellogg" ] .
{ "@context": { "foaf": "http://xmlns.com/foaf/0.1/" }, "@id": "http://manu.sporny.org/i/public", "@type": "foaf:Person", "foaf:name": "Manu Sporny", "foaf:knows": { "@type": "foaf:Person", "foaf:name": "Gregg Kellogg" } }
Both JSON-LD and Turtle can represent sequential lists of values.
@prefix foaf: <http://xmlns.com/foaf/0.1/> . <http://example.org/people#joebob> a foaf:Person; foaf:name "Joe Bob"; foaf:nick ( "joe" "bob" "jaybee" ) .
{ "@context": { "foaf": "http://xmlns.com/foaf/0.1/" }, "@id": "http://example.org/people#joebob", "@type": "foaf:Person", "foaf:name": "Joe Bob", "foaf:nick": { "@list": [ "joe", "bob", "jaybee" ] } }
The following example describes three people with their respective names and homepages.
<div prefix="foaf: http://xmlns.com/foaf/0.1/"> <ul> <li typeof="foaf:Person"> <a rel="foaf:homepage" href="http://example.com/bob/" property="foaf:name" >Bob</a> </li> <li typeof="foaf:Person"> <a rel="foaf:homepage" href="http://example.com/eve/" property="foaf:name" >Eve</a> </li> <li typeof="foaf:Person"> <a rel="foaf:homepage" href="http://example.com/manu/" property="foaf:name" >Manu</a> </li> </ul> </div>
An example JSON-LD implementation using a single context is described below.
{ "@context": { "foaf": "http://xmlns.com/foaf/0.1/" }, "@graph": [ { "@type": "foaf:Person", "foaf:homepage": "http://example.com/bob/", "foaf:name": "Bob" }, { "@type": "foaf:Person", "foaf:homepage": "http://example.com/eve/", "foaf:name": "Eve" }, { "@type": "foaf:Person", "foaf:homepage": "http://example.com/manu/", "foaf:name": "Manu" } ] }
The following example uses a simple Microformats hCard example to express how the Microformat is represented in JSON-LD.
<div class="vcard"> <a class="url fn" href="http://tantek.com/">Tantek Çelik</a> </div>
The representation of the hCard expresses the Microformat terms in the
context and uses them directly for the url
and fn
properties. Also note that the Microformat to JSON-LD processor has
generated the proper URL type for http://tantek.com/
.
{ "@context": { "vcard": "http://microformats.org/profile/hcard#vcard", "url": { "@id": "http://microformats.org/profile/hcard#url", "@type": "@id" }, "fn": "http://microformats.org/profile/hcard#fn" }, "@type": "vcard", "url": "http://tantek.com/", "fn": "Tantek Çelik" }
The microdata example below expresses book information as a microdata Work item.
<dl itemscope itemtype="http://purl.org/vocab/frbr/core#Work" itemid="http://purl.oreilly.com/works/45U8QJGZSQKDH8N"> <dt>Title</dt> <dd><cite itemprop="http://purl.org/dc/terms/title">Just a Geek</cite></dd> <dt>By</dt> <dd><span itemprop="http://purl.org/dc/terms/creator">Wil Wheaton</span></dd> <dt>Format</dt> <dd itemprop="http://purl.org/vocab/frbr/core#realization" itemscope itemtype="http://purl.org/vocab/frbr/core#Expression" itemid="http://purl.oreilly.com/products/9780596007683.BOOK"> <link itemprop="http://purl.org/dc/terms/type" href="http://purl.oreilly.com/product-types/BOOK"> Print </dd> <dd itemprop="http://purl.org/vocab/frbr/core#realization" itemscope itemtype="http://purl.org/vocab/frbr/core#Expression" itemid="http://purl.oreilly.com/products/9780596802189.EBOOK"> <link itemprop="http://purl.org/dc/terms/type" href="http://purl.oreilly.com/product-types/EBOOK"> Ebook </dd> </dl>
Note that the JSON-LD representation of the Microdata information stays true to the desires of the Microdata community to avoid contexts and instead refer to items by their full IRI.
[ { "@id": "http://purl.oreilly.com/works/45U8QJGZSQKDH8N", "@type": "http://purl.org/vocab/frbr/core#Work", "http://purl.org/dc/terms/title": "Just a Geek", "http://purl.org/dc/terms/creator": "Whil Wheaton", "http://purl.org/vocab/frbr/core#realization": [ "http://purl.oreilly.com/products/9780596007683.BOOK", "http://purl.oreilly.com/products/9780596802189.EBOOK" ] }, { "@id": "http://purl.oreilly.com/products/9780596007683.BOOK", "@type": "http://purl.org/vocab/frbr/core#Expression", "http://purl.org/dc/terms/type": "http://purl.oreilly.com/product-types/BOOK" }, { "@id": "http://purl.oreilly.com/products/9780596802189.EBOOK", "@type": "http://purl.org/vocab/frbr/core#Expression", "http://purl.org/dc/terms/type": "http://purl.oreilly.com/product-types/EBOOK" } ]
This section is non-normative.
This section is included merely for standards community review and will be submitted to the Internet Engineering Steering Group if this specification becomes a W3C Recommendation.
form
expanded
. If no form is
specified in an HTTP request header to an HTTP server, the server may
choose any form. If no form is specified in an HTTP response, the form
must not be assumed to take any particular form.application/json
MIME media type.eval()
function. It is recommended that a conforming parser does not attempt to
directly evaluate the JSON-LD serialization and instead purely parse the
input into a language-native data structure. Fragment identifiers used with application/ld+json resources may identify a node in the linked data graph expressed in the resource. This idiom, which is also used in RDF [RDF-CONCEPTS], gives a simple way to "mint" new, document-local IRIs to label nodes and therefore contributes considerably to the expressive power of JSON-LD.
This section is non-normative.
A large amount of thanks goes out to the JSON-LD Community Group participants who worked through many of the technical issues on the mailing list and the weekly telecons - of special mention are Niklas Lindström, François Daoust, and Zdenko 'Denny' Vrandečić. The editors would like to thank Mark Birbeck, who provided a great deal of the initial push behind the JSON-LD work via his work on RDFj. The work of Dave Lehn and Mike Johnson are appreciated for reviewing, and performing several implementations of the specification. Ian Davis is thanked for this work on RDF/JSON. Thanks also to Nathan Rixham, Bradley P. Allen, Kingsley Idehen, Glenn McDonald, Alexandre Passant, Danny Ayers, Ted Thibodeau Jr., Olivier Grisel, Josh Mandel, Eric Prud'hommeaux, David Wood, Guus Schreiber, Pat Hayes, Sandro Hawke, and Richard Cyganiak for their input on the specification.