This document is also available in this non-normative format: diff to previous version
Copyright
©
2010-2012
the
Contributors
to
the
JSON-LD
Syntax
1.0
Specification,
published
by
the
JSON
for
Linking
Data
Community
Group
W3C
under
the
®
(
MIT
,
ERCIM
,
Keio
),
All
Rights
Reserved.
W3C
Community
Final
Specification
Agreement
(FSA)
.
A
human-readable
summary
liability
,
trademark
is
available.
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
specification
was
published
by
section
describes
the
JSON
for
Linking
Data
Community
Group
.
It
is
not
a
W3C
Standard
nor
is
it
on
status
of
this
document
at
the
time
of
its
publication.
Other
documents
may
supersede
this
document.
A
list
of
current
W3C
Standards
Track.
Please
note
that
under
publications
and
the
latest
revision
of
this
technical
report
can
be
found
in
the
W3C
Community
Final
Specification
Agreement
(FSA)
technical
reports
index
other
conditions
apply.
Learn
more
about
W3C
Community
and
Business
Groups
.
at
http://www.w3.org/TR/.
This
document
has
been
under
development
for
over
18
months
in
the
JSON
for
Linking
Data
Community
Group.
The
document
has
recently
been
cleared
transferred
to
be
moved
into
the
RDF
Working
Group
for
review
review,
improvement,
and
publication
along
the
Recommendation
track.
This
While
this
is
a
First
Public
Working
Draft
publication,
the
specification
has
undergone
significant
development,
review,
and
changes
during
the
course
of
the
last
18
months
and
is
being
published
as
a
Final
Community
Group
Specification
to
transition
the
work
into
more
mature
than
the
RDF
First
Public
Working
Group.
Draft
status
implies.
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 a First Public Working Draft. This document is intended to become a W3C Recommendation. 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 a Working 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 thing s that the document describes. These things may also be identified using IRI s. 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 only requires a very small memory footprint in order to operate.
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 ].
JSON [ RFC4627 ] defines several terms which are used throughout this document:
@value
,
@list
or
@set
and
it
has
one
or
more
keys
other
than
@id
.
@id
key.
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.
The following definition for Linked Data is the one that will be used for this specification.
An illustration of a linked data graph would probably help here.
EricP suggests that the definitions of subject and object, while being practical, are at odds with [ RDF-CONCEPTS ] use in their roles within a triple.
JSON-LD allows properties to be BNodes, while RDF does not. When used as just JSON-LD, this is not unreasonable; it only becomes an issue (and could raise an exception) when transformed to RDF.
Note that the definition for Linked Data above 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.
JSON-LD defines a mechanism to map JSON terms, 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 . There are a few techniques that can ensure that developers will generate good Linked Data for the Web. JSON-LD formalizes those techniques.
We will be using the following JSON markup as the example for the rest of this section:
{ "name": "Manu Sporny", "homepage": "http://manu.sporny.org/", "depiction": "http://twitter.com/account/profile_image/manusporny" }
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
The
Context
.
@graph
@id
@value
@language
@type
@container
@list
@set
:
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
term
s,
i.e.,
properties
with
associated
values
in
an
JSON
document,
to
IRI
s.
A
term
is
a
short
word
that
expands
to
an
IRI
.
Term
s
may
be
defined
as
any
valid
JSON
string
other
than
a
JSON-LD
keyword
.
To
avoid
forward-compatibility
issues,
term
s
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
term
s
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
term
s
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
name/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 term s 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" }, } }
Assuming
that
this
context
document
can
be
retrieved
at
http://json-ld.org/contexts/person.jsonld
,
it
can
be
referenced
from
a
JSON-LD
document
by
adding
a
single
line.
The
JSON
markup
shown
in
the
previous
section
could
be
changed
as
follows:
{
"@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
term
s
as
well
as
other
processing
instructions
for
the
JSON-LD
processor.
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 subject definition is defined. A subject 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 term s must be overridden using a last-defined-overrides mechanism.
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
subject
definition
are
referred
to
as
local
context
s.
Setting
the
context
to
null
effectively
sets
the
local
context
to
the
initial
context
(further
explained
in
the
JSON-LD
API,
Appendix
A,
Initial
Context
[
JSON-LD-API
]
).
The
active
context
refers
to
the
accumulation
of
local
context
s
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 term s 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
set
the
subject
of
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
subject
definition
.
Subject
definitions
do
not
require
an
@id
.
Subject
definitions
that
do
not
contain
an
@id
are
known
as
an
unlabeled
nodes
.
IRI s are fundamental to Linked Data as that is how most subject s, all properties and many object s are identified. IRI s can be expressed in a variety of different ways in JSON-LD.
@id
or
@type
.
@id
.
IRIs may be represented as an absolute IRI , a relative IRI , a term , or a compact IRI .
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 IRI s 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'", ... }
Term s 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.
Prefix
es
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
Compact
IRIs
for
more
details.
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
object
using
an
IRI
.
When
the
object
has
only
the
@id
,
it
is
called
a
subject
reference
.
This
facility
may
also
be
used
to
link
to
another
subject
definition
using
a
mechanism
called
embedding
,
which
is
covered
in
the
section
titled
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. IRI s 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.
A
subject
of
a
JSON
object
is
a
node
identified
using
the
@id
key.
The
subject
is
the
first
piece
of
information
needed
by
the
JSON-LD
processor
in
order
to
create
the
(subject,
property,
object)
tuple,
also
known
as
a
triple.
{ "@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
would
set
the
subject
to
the
IRI
http://example.org/people#joebob
.
A
JSON
object
used
to
define
property
values
is
called
a
subject
definition
.
Subject
definitions
do
not
require
an
@id
.
A
subject
definition
that
does
not
contain
an
@id
property
defines
properties
of
an
unlabeled
node
.
To
ensure
the
best
possible
performance,
when
possible,
it
is
a
best
practice
to
put
JSON-LD
keyword
s,
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
subject
can
be
specified
using
the
@type
keyword
.
Specifying
the
type
in
this
way
will
generate
a
triple
of
the
form
(subject,
type,
type-
IRI
).
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", ... }
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
string
s
花澄
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 string s. That is, typed value s or values that are subject to 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 term s. See Expanded Term Definition for more details.
A JSON-LD document is first, and foremost, a JSON document (as defined in [ RFC5988 ]), 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 Syntax Tokens and Keywords for expressing subject definitions , values, and the context . See Appendix A 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.
Term s 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 term s 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 term s, 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
IRI
s
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 two 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
an
object
with
the
value
of
2010-05-29T14:17:39+02:00
and
the
type
of
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
subject
.
Although
the
same
keyword
is
used
in
both
places,
the
concept
of
an
object
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.
Authors may choose to declare JSON-LD context s in external documents to promote re-use of contexts as well as reduce the size of JSON-LD documents.
In
order
to
use
an
external
context,
an
author
must
specify
an
IRI
to
a
valid
JSON-LD
document.
The
referenced
document
must
have
a
top-level
subject
definition
.
The
value
of
any
@context
key
within
that
object
is
substituted
for
the
IRI
within
the
referencing
document
to
have
the
same
effect
as
if
the
value
were
specified
inline
within
the
referencing
document.
The following example demonstrates the use of an external context:
{
"@context": "http://json-ld.org/contexts/person.jsonld",
"name": "Manu Sporny",
"homepage": "http://manu.sporny.org/",
"depiction": "http://twitter.com/account/profile_image/manusporny"
}
Authors may also import multiple contexts or a combination of external and local contexts by specifying a list of contexts:
{ "@context": [ "http://json-ld.org/contexts/person.jsonld", { "foaf": "http://xmlns.com/foaf/0.1/" }, "http://json-ld.org/contexts/event.jsonld" ], "name": "Manu Sporny", "homepage": "http://manu.sporny.org/", "foaf:depiction": "http://twitter.com/account/profile_image/manusporny", "celebrates": { "@type": "Event", "description": "International Talk Like a Pirate Day", "date": "R/2011-09-19" } }
Each context in a list will be evaluated in-order. Duplicate mappings among the context s must be overwritten on a last-defined-overrides basis. The context list must contain either de-referenceable IRI s or JSON object s that conform to the context syntax as described in this document.
An author may nest contexts within subject definitions , with the more deeply nested contexts overriding the values in previously defined contexts:
{ "@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
the
JSON
object
has
legacy
applications
using
the
structure
of
the
object.
External
JSON-LD
context
documents
may
contain
extra
information
located
outside
of
the
@context
key,
such
as
documentation
about
the
prefixes
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.
It
is
also
recommended
that
a
human-readable
document
is
served
as
well
to
explain
the
correct
usage
of
the
JSON-LD
context
document.
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
subject
definition
.
The
@context
subtree
within
that
object
is
added
to
the
top-level
subject
definition
of
the
referencing
document.
If
an
array
is
at
the
top-level
of
the
referencing
document
and
its
items
are
subject
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, term s may be defined using an expanded notation to allow for additional information associated with the term to be specified (see also Type Coercion and 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
subject
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 Type Coercion , 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 IRI s to term s. 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
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 value s, 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 .
In
general,
normal
IRI
expansion
rules
apply
anywhere
an
IRI
is
expected
(see
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
value
s:
{ "@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.
Term s 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
term
s
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 array s. Since graphs do not describe ordering for links between nodes, arrays in JSON-LD do not provide an ordering of the listed objects 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 three triples being generated, each relating the subject to an individual object , with no inherent order:
<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 triples, again with no inherent order:
<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
compacted
document
.
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.
Object embedding is a JSON-LD feature that allows an author to use subject definitions as property values. This is a commonly used mechanism for creating a parent-child relationship between two subject s.
The example shows two subjects related by a property from the first subject:
{ ... "name": "Manu Sporny", "knows": { "@type": "Person", "name": "Gregg Kellogg", } ... }
A subject 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
subject
definition
s
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
subject
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
subject
definition
,
this
describes
resources
in
the
default
graph
.
This
is
equivalent
to
using
multiple
subject
definitions
in
array
and
defining
the
@context
within
each
subject
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
subject
.
{
"@context": ...,
"@id": "http://example.org/graphs/73",
"asOf": { "@value": "2012-04-09", "@type": "xsd:date" },
"@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"
}
]
}
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.
Meta-data
about
the
graph
itself
is
also
expressed
via
the
asOf
property,
which
specifies
when
the
information
was
retrieved
from
the
Web.
These examples could all have TriG definitions of their RDF results, but that would involve adding RDF earlier in the document.
At
times,
it
becomes
necessary
to
be
able
to
express
information
without
being
able
to
specify
the
subject.
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
subject
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
subject
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 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
expanding
the
document
.
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.
Since the JSON-LD syntax is a subset of the JSON syntax, it follows that all valid JSON-LD documents are valid JSON documents. It also means that an invalid JSON document can never be a valid JSON-LD document. Furthermore, JSON-LD places a number of restrictions on the JSON syntax in order to define a set of authoring guidelines that are used to express well-formed JSON-LD documents. At times, even if these guidelines are violated, a JSON-LD processor will do its best to recover from the mistake and will deterministically transform the author's markup into well-formed JSON-LD.
The final details of the guidelines are still being discussed ( ISSUE-114 ), as well as the best mechanism to express these restrictions. EBNF doesn't quite capture what these guidelines are attempting to do - which is strongly express what constitutes a well-formed JSON-LD document. For the time being, a simple list of plain English guidelines are provided.
Per Andy S's comment , consider making this a normative syntax definition along with EBNF.
@id
must
be
a
term
,
a
compact
IRI
,
or
an
IRI
.
@id
keyword
and
a
@language
keyword
must
not
exist
in
the
same
JSON
object
.
@id
keyword
and
a
@container
keyword
must
not
exist
in
the
same
JSON
object
.
@context
property.
@context
value
must
not
contain
an
embedded
@context
definition.
@context
keyword
must
be
a
string
expanding
to
an
IRI
,
a
JSON
object
,
null,
or
an
array
containing
a
combination
of
the
allowed
values.
@context
must
be
a
null
,
an
IRI
,
or
a
JSON
object
.
@context
:
@graph
property.
@graph
property
must
be
a
subject
definition
or
an
array
of
zero
or
more
subject
definitions
.
@set
key
must
not
have
any
other
keys.
@list
key
must
not
have
any
other
keys.
@set
or
@list
key
can
be
a
string,
a
number,
a
JSON
object
,
or
an
array
containing
a
combination
of
the
allowed
values.
@value
key:
@language
or
@type
property
and
must
not
have
any
other
properties.
@language
and
@type
keys
at
the
same
time.
@value
key
must
be
a
string
or
a
number.
@language
key
must
be
null
or
a
string
in
[
BCP47
]
format.
@type
must
be
null
,
a
term
,
a
compact
IRI
,
an
IRI
,
a
JSON
object
,
or
an
array
containing
a
combination
of
the
allowed
values.
@type
must
not
be
@id
.
This
is
in
contrast
to
the
use
of
@type
in
the
@context
,
where
this
is
allowed.
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
IRI
s
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.
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.
Instead,
authors
may
use
a
prefix
definition
to
resolve
relative
IRI
s:
{ "@context": { "base": "http://manu.sporny.org/", "foaf": "http://xmlns.com/foaf/0.1/" }, "@id": "base:i/public", "@type": "foaf:Person", "foaf:name": "Manu Sporny", "foaf:homepage": { "@id": "base" } }
Both Turtle and JSON-LD allow embedding of objects, although Turtle only allows embedding of objects which use unlabeled node identifiers.
@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.
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, Dave Lehn and Mike Johnson who reviewed, provided feedback, and performed several implementations of the specification, and Ian Davis, who created 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.