This blog has been re-posted and edited with permission from Dries Buytaert’s blog.
Drupal core now provides an out-of-the-box JSON:API implementation, marking another major milestone toward making Drupal API-first.
Breaking news: we just committed the JSON:API module to the development branch of Drupal 8.
In other words, JSON:API support is coming to all Drupal 8 sites in just a few short months! 🎉
This marks another important milestone in Drupal’s evolution to be an API-first platform optimized for building both coupled and decoupled applications.
When you enable the JSON:API module, all Drupal entities such as blog posts, users, tags, comments and more become accessible via the JSON:API web service API. JSON:API provides a standardized API for reading and modifying resources (entities), interacting with relationships between resources (entity references), fetching of only the selected fields (e.g. only the “title” and “author” fields), including related resources to avoid additional requests (e.g. details about the content’s author) and filtering, sorting and paginating collections of resources.
In addition to being incredibly powerful, JSON:API is easy to learn and useand uses all the tooling we already have available to test, debug and scale Drupal sites.
Drupal’s JSON:API implementation was years in the making
Development of the JSON:API module started in May 2016 and reached a stable 1.0 release in May 2017. Most of the work was driven by a single developer partially in his free time: Mateu Aguiló Bosch (e0ipso).
After soliciting input and consulting others, I felt JSON:API belonged in Drupal core. I first floated this idea in July 2016, became more convinced in December 2016 and recommended that we standardize on it in October 2017.
Wim and Gabe quickly became key contributors alongside Mateu. They wrote hundreds of tests and added missing features to make sure we guarantee strict compliance with the JSON:API specification.
A year later, their work culminated in a JSON:API 2.0 stable release on January 7th, 2019. The 2.0 release marked the start of the module’s move to Drupal core. After rigorous reviews and more improvements, the module was finally committed to core earlier today.
The best JSON:API implementation in existence
The JSON:API module is almost certainly the most feature-complete and easiest-to-use JSON:API implementation in existence.
The Drupal JSON:API implementation supports every feature of the JSON:API 1.0 specification out-of-the-box. Every Drupal entity (a resource object in JSON:API terminology) is automatically made available through JSON:API. Existing access controls for both reading and writing are respected. Both translations and revisions of entities are also made available. Furthermore, querying entities (filtering resource collections in JSON:API terminology) is possible without any configuration (e.g. setting up a “Drupal View”), which means front-end developers can get started on their work right away.
What is particularly rewarding is that all of this was made possible thanks to Drupal’s data model and introspection capabilities. Drupal’s decade-old Entity API, Field API, Access APIs and more recent Configuration and Typed Data APIs exist as an incredibly robust foundation for making Drupal’s data available via web service APIs. This is not to be understated, as it makes the JSON:API implementation robust, deeply integrated and elegant.
I want to extend a special thank you to the many contributors that contributed to the JSON:API module and that helped make it possible for JSON:API to be added to Drupal 8.7.
Special thanks to Wim Leers (Acquia) and Gabe Sullice (Acquia) for co-authoring this blog post and to Mateu Aguiló Bosch (e0ipso) (Lullabot), Preston So (Acquia), Alex Bronstein (Acquia) for their feedback during the writing process.