Customize your API Catalog
Customize your API Docs
The API Doc is a Drupal entity. You can modify it at Structure > API Doc settings in the Drupal admin menu.
Customize the catalog listing
The APIs landing page is a Drupal view. You can modify it by editing the API Catalog view under Structure > Views in the admin menu.
Display OpenAPI specs using other rendering formats
Once the OpenAPI spec is added to the developer portal as an API Doc, it is rendered on its own API Doc page using Apigee SmartDocs (Angular application that is embedded in the API Doc page).
However, you can use other rendering formats, such as the Swagger UI Field Formatter or Scalar UI Field Formatter, to display documentation within your API Catalog.
Swagger UI
To render the OpenAPI spec using Swagger UI:
- Install and enable the Swagger UI Field Formatter module.
- Install the Swagger UI JS library as documented on the module page.
- Log in to your portal as a user with admin or content creation privileges.
- Go to Structure > API Doc settings > Manage display in the admin menu.
- Change the OpenAPI specification field format to use the Swagger UI field formatter.
- Click Save.
Scalar
Alternatively, to render the OpenAPI spec using Scalar:
- Install the Scalar API module and enable the Scalar UI Formatter (
scalar_ui_formatter) sub-module. - Note: The Scalar JS library is loaded via CDN by default, so no extra library installation is required (though you can install it locally as documented on the module page).
- Log in to your portal as a user with admin or content creation privileges.
- Go to Structure > API Doc settings > Manage display in the admin menu.
- Change the OpenAPI specification field format to use the Scalar API Viewer formatter.
- Click Save.
Redoc
The Redoc does not have Field Formatter and integration for Drupal relies on the OpenAPI UI ecosystem.
-
Requirement: Install the OpenAPI UI base module and the Redoc for OpenAPI UI plugin.
Note: Redoc is excellent for SEO as it renders human-readable documentation that is easily indexed by search engines. -
Configuration: Navigate to
Structure > API Doc settings > Manage display.
Under the OpenAPI specification field, change the formatter to OpenAPI UI.
In the formatter settings (gear icon), select Redoc as the UI library. -
Use Redoc if your audience includes non-developers (like Product Managers or Partners) who need to browse the API structure without the visual "noise" of testing tools.
Compare rendering formats
A quick reference table:
| Feature | SmartDocs | Swagger UI | Scalar | Redoc |
| Primary Focus | Apigee Ecosystem | Interactive Testing | Modern DX & Speed | Clean Readability |
| Aesthetic | Classic / Corporate | Standard / Functional | Modern / Minimalist | Classic 3-Panel |
| "Try it Out" | Yes | Yes | Yes (Advanced) | No (OSS version) |
| Field Formatter Module | Built-in (Apigee) | Swagger UI Formatter | Scalar API | No |
| OpenAPI Module support | No | OpenAPI Swagger UI | Scalar API | OpenAPI UI Redoc |
| Drupal 11 Compatible | Yes | Yes | Yes | Yes |
| Drupal 12 Compatible | No | No | No | No |
Help improve this page
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion