A shared media type for JSON APIs.
CSS Ruby JavaScript
Pull request Compare This branch is 1205 commits behind json-api:gh-pages.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_includes
_layouts
about
examples
extending
faq
format
images
javascripts
status
stylesheets
.gitignore
CNAME
Gemfile
README.md
Rakefile
_config.yml
index.md

README.md

JSON API

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

Resources

  • IRC channel: #jsonapi on freenode.net
  • Twitter: @jsonapi

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.