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, which is an Angular application that is embedded in the API Doc page. However, you can use other rendering formats, such as the Swagger UI Field Formatter, to display documentation within your API Catalog.

For example, to render the OpenAPI spec using Swagger UI:

1. Install and enable the Swagger UI Field Formatter module.
2. Install the Swagger UI JS library as documented on the module page.
3. Log in to your portal as a user with admin or content creation privileges.
4. Go to Structure > API Doc settings > Manage display in the admin menu.
5. Change the OpenAPI specification field format to use the Swagger UI field formatter.
6. Click Save.