This module generates JSON-Schema definitions for your site's JSON:API resources. These schemas comprehensively describe the structure of JSON:API responses, allowing you to navigate and understand your API's data format.
JSON:API Schema provides JSON-Schema formatted schemas for JSON:API resources.
These schemas describe a JSON:API response in its entirety, i.e., the schemas completely define the top-level object, not just a resource objects.
To begin exploring your site's schema, visit /jsonapi/schema, from there, you can traverse a graph of interconnected schemas describing your entire JSON:API implementation.
This module requires Drupal core 8.8 or higher.
Ask your assistant about JSON:API Schema
Check compatibility with your Drupal and PHP version, maintenance and security coverage, from current release data. How it works
Depends on
Dependencies of the latest stable release
- jsonapi Drupal core
- serialization Drupal core
Required by
Tracked projects that depend on this one
No tracked projects depend on this one yet.
Activity
Release Timeline
Releases
| Version | Type | Core | PHP | Release date | |
|---|---|---|---|---|---|
| 8.x-1.0 | Stable | 10–11 | May 20, 2025 | ||
| 2.0.x-dev | Dev | 10 | Dec 11, 2024 | ||
| 2.x-dev | Dev | 10 | Jun 24, 2024 | ||
| 8.x-1.0-rc1 | Pre-release | 8–10 | Sep 1, 2023 |