A specification for building JSON APIs
CSS JavaScript HTML Python Makefile Groovy Other
Clone or download
Permalink
Failed to load latest commit information.
_format Change RFC2119 wording to be consistent with RFC8174 (#1279) May 27, 2018
_includes Replace "Github" with "GitHub" Oct 27, 2015
_layouts Simplify page.title vs. page_title Sep 12, 2016
about Remove 1.1 release date, no longer applicable May 23, 2016
alt-favicons Add a favicon Dec 21, 2015
design Add a favicon Dec 21, 2015
examples Fixed typo 'auther' to 'author' Sep 11, 2017
extensions Fix header id Apr 13, 2016
faq Fix actions discovery FAQ Nov 6, 2015
fonts Replace Google+ (icon) with link to new Discourse forum Nov 10, 2015
images Rework masthead and logo. May 19, 2015
implementations Add JSON API Doc Python client (#1285) Jul 29, 2018
javascripts Fix syntax highlighting May 1, 2016
recommendations Clarify pending async process response #1223 Oct 14, 2017
stylesheets Cleanup `code` formatting Jul 15, 2017
.gitignore Include all css as well as scss to keep Jekyll happy May 1, 2014
CNAME Set CNAME to main domain. May 10, 2013
CONTRIBUTING.md remove inconsistent dash Jun 29, 2015
Gemfile Deprecate existing extensions (#1026) Apr 13, 2016
LICENSE add creative commons c0 license May 21, 2015
README.md include list of archived versions for further reference Sep 10, 2015
Rakefile Redirect from old status page Nov 10, 2015
_config.yml Switch to kramdown in config May 1, 2016
favicon.ico Add a favicon Dec 21, 2015
index.md Update index.md - change from 'post' -> 'article' Jul 22, 2016
schema Merge branch 'gh-pages' into self_links_want_to_be_objects_too Jul 26, 2017

README.md

JSON API

Documentation for the application/vnd.api+json media type, a specification for APIs that use JSON. This repository is the source code for http://jsonapi.org.

Resources

Status

This standard is currently under development. To assist:

  1. Get the dependencies:

    $ bundle

  2. Host the site locally while editing:

    $ bundle exec rake preview:browser

  3. Edit the Markdown files.

  4. Commit your changes.

  5. Send a Pull Request when finished.

The website is automatically built by GitHub Pages when changes are pushed to the gh-pages branch.

Archive

older versions of the JSON-API documentations