OpenAPI UI

The OpenAPI UI module implements an API around displaying OpenAPI specs inside a Drupal site. This library implements a plugin base which can be used to initialize a API explorer UI within your site. This module does not come with any implemented plugins, but implementations for Swagger UI and ReDoc are available as Drupal modules. Please visit the Swagger for OpenAPI UI module and ReDoc for OpenAPI UI module pages for information about using those libraries.

Whats OpenAPI (A.K.A. Swagger)?

OpenAPI is a specification for documenting web service apis, that are consistent and reusable by developers. Using a consistent format allows for the reuse of api client libraries and a consistent experience for learning a new api.

This module fits into the OpenAPI ecosystem by providing integrations between Drupal and libraries for displaying the api spec for use by both developers and end users. For information about OpenAPI specifications for Drupal's apis and the API's for other contributed modules, take a look at the OpenAPI module.

Supported Libraries

• Swagger UI using the Swagger for OpenAPI UI module
• ReDoc using the ReDoc for OpenAPI UI module

Viewing docs on Drupal's APIs

Looking to view documentation on Drupal's APIs? While this module doesn't provide the documentation, you can install it alongside OpenAPI module to view docs for the JSON:API and REST modules, found in Drupal core. You will need to also install one supported UI library implementations in order to view the docs.

Please visit the OpenAPI project page for more information.

Related Projects

• OpenAPI - Provides OpenAPI/Swagger documentation for Drupal Core and contributed modules
• Swagger UI Field Formatter - Provides a field formatter to display a the contents of files fields using the Swagger UI interface.