This module generates OpenAPI definitions for your Drupal site's core REST API. It enables you to document your API, making it easier for developers to understand and interact with. You'll need to enable this module along with an OpenAPI UI generator, such as Redoc, to view the documentation.
Integrates with the base Open API module to generate the definitions for core REST. If you want documentation of your core REST powered API, you need to enable this module and a documentation generator like Open API UI ReDoc. Check out the Open API project for more information about alternative UI generators.
This module requires Open API 2.x or above.
This module does provides the necessary plugins for the Open API to serve the JSON:API definition document. For that it needs at least Open API (8.x-2.x).
Version notes
The version 2.x of this Drupal module implements version 2 of the Open API specification.
On the other hand, version 3.x of this Drupal module implements version 3 (latest and better supported) of the Open API specification.
Depends on
Dependencies of the latest stable release
- OpenAPI >=8.x-2.0-rc1
- schemata
- schemata_json_schema
- rest Drupal core
Required by
Tracked projects that depend on this one
No tracked projects depend on this one yet.
Activity
Releases
| Version | Type | Core | Notes | Release date | |
|---|---|---|---|---|---|
| 8.x-2.0 | Stable | 10–11 | 2.0 Release | Oct 15, 2025 |