Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.This project is not covered by Drupal’s security advisory policy.
Replaced by:
JSON:API is now part of Drupal core!
All supported versions of Drupal core are distributed with the 8.x-2.x branch of the JSON:API module. As of 7 January, 2020, the 8.x-1.x of JSON:API is unsupported.
Security vulnerabilities for JSON:API in Drupal core should be submitted from the Drupal core project page by following the "Report a security vulnerability" link on that page.
Generate an API server that implements the JSON:API specification.
Documentation
See Drupal core documentation for the JSON:API module for documentation of the current Drupal 8, Drupal 9, and beyond included-in-core versions.
Please read the documentation to further your understanding on how to use the JSON:API module.
This YouTube playlist contains a series of short videos covering the implementation status of the module:
Please Contribute 🙏
There are lots of ways to contribute! Many of them don't require any coding either!
- File an experience report in the issue queue.
- Test out the latest dev branch, especially with a variety of modules and configuration. What can you break?
- Read the docs!
- Help us find missing concepts or confusing bits.
- Help us find typos and grammatical errors.
If you do want to jump in and code, see if you can tackle something in the issue queue and, if not, there are plenty of small code cleanups one could do. We know the module is pretty big and intimidating though, so feel free to file an issue asking for a code tour to help you get acquainted with the codebase first.
Ecosystem
Check out the ecosystem page to learn about other modules integrating with JSON:API.
Contenta CMS
This module is part of the Contenta CMS decoupled distribution and integrates with Contenta JS. Learn more about these projects:
Extend JSON:API
This module is zero configuration. Once you enable the module, you are done.
If you need to customize your API you may be interested in the JSON:API Extras module.
JSON:API has a growing ecosystem. Check it out here!
Project information
Unsupported
Not supported (i.e. abandoned), and no longer being developed. Learn more about dealing with unsupported (abandoned) projects- Obsolete
Use of this project is deprecated. - Module categories: Decoupled, Integrations
329 sites report using this module- Created by e0ipso on , updated
This project is not covered by the security advisory policy.
Use at your own risk! It may have publicly disclosed vulnerabilities.
