Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A specification for building JSON APIs
CSS HTML JavaScript Ruby

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

  • 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.

Something went wrong with that request. Please try again.