W3C home > Mailing lists > Public > public-linked-json@w3.org > June 2016

JSON-LD API Best Practices note

From: Gregg Kellogg <gregg@greggkellogg.net>
Date: Mon, 6 Jun 2016 11:29:49 -0700
Message-Id: <6D73BA45-1C69-49A3-97B3-525AF3AB85D5@greggkellogg.net>
To: JSON-LD CG <public-linked-json@w3.org>
I’ve pushed up an in-progress draft of "Building JSON-LD APIs: Best Practices” [1]. This work started because of questions and general uncertainty on the best use of JSON-LD for building APIs, and generating JSON-LD in general. This is not an attempt to break new ground, but to codify experience that’s been developed over the time of JSON-LD adoption.

The purpose of this document is to allow an easy entry point for developers wishing to produce or consume APIs using JSON, pointing out the advantages of JSON-LD. It is _not_ intended to generally promote Linked Data or RDF as an end in itself.

At this point, there’s little mention of REST, and describing affordances. As there are different practices for this, my intention is to describe schema.org Actions [2] as one means of describing API affordances, in addition to referencing the standardized Linked Data Platform [3] and ongoing work in the Hydra Vocabulary [4].

Suggestions for new best practices, pull requests and general issues can be made on the GitHub issue tracker [5] using the “best practices” label, or on public-linked-json@w3.org.

Gregg Kellogg
gregg@greggkellogg.net

[1] http://json-ld.org/spec/latest/json-ld-api-best-practices/
[2] https://schema.org/docs/actions.html
[3] http://www.w3.org/TR/ldp/
[4] http://www.hydra-cg.com
[5] https://github.com/json-ld/json-ld.org/issues
Received on Monday, 6 June 2016 18:30:22 UTC

This archive was generated by hypermail 2.3.1 : Monday, 6 June 2016 18:30:23 UTC