https://github.com/json-api/json-api

A specification for building JSON APIs
https://github.com/json-api/json-api

Last synced: 20 days ago
JSON representation

A specification for building JSON APIs

• Host: GitHub
• URL: https://github.com/json-api/json-api
• Owner: json-api
• License: cc0-1.0
• Created: 2013-05-04T19:29:30.000Z (over 11 years ago)
• Default Branch: gh-pages
• Last Pushed: 2024-09-17T16:53:35.000Z (about 2 months ago)
• Last Synced: 2024-10-02T02:08:15.342Z (about 1 month ago)
• Language: CSS
• Homepage: https://jsonapi.org
• Size: 2.8 MB
• Stars: 7,430
• Watchers: 206
• Forks: 843
• Open Issues: 136
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• favorite-link - 用于构建 JSON API 的规范。
• awesome - json-api/json-api - A specification for building JSON APIs (CSS)
• awesome-integration - JSON:API (⭐7.4k) - A standardized specification for building APIs that simplifies the representation of resources, relationships, and metadata, making it easier for software engineers to create efficient APIs. (Resources / API Specification)
• starred-awesome - json-api - A specification for building JSON APIs (CSS)
• awesome - json-api/json-api - A specification for building JSON APIs (CSS)

README

        
JSON:API

========

Documentation for the [application/vnd.api+json media

type](http://www.iana.org/assignments/media-types/application/vnd.api+json),

a specification for APIs that use JSON. This repository is the

source code for [http://jsonapi.org](http://jsonapi.org).

Resources

---------

* IRC channel: #jsonapi on freenode.net

* Twitter: @jsonapi

* Discourse: [http://discuss.jsonapi.org](http://discuss.jsonapi.org)

Status

------

This standard is currently under development. To assist:

1. Get the dependencies:

    `$ bundle`

1. Host the site locally while editing:

    `$ bundle exec rake preview:browser`

1. Edit the Markdown files.

1. Commit your changes.

1. Send a Pull Request when finished.

The website is automatically built by [GitHub Pages](http://pages.github.com)

when changes are pushed to the `gh-pages` branch.

Archive

-------

older versions of the JSON:API documentations

* RC3 - http://jsonapi-rc3.herokuapp.com/