Install the API Catalog module

Using Apigee Developer Portal Kickstart distribution

If you have installed your developer portal site using the Kickstart distribution, the Apigee API Catalog module has already been downloaded with all of its dependencies as part of the Kickstart installation script.

Install as a standalone module

This module must be installed on a Drupal site that is managed by Composer. Drupal.org has documentation on how to use Composer to manage Drupal site dependencies to get you started quickly.

1. Install the module using Composer.
   Composer will download the this module and all its dependencies.
   Note: Composer must be executed at the root of your Drupal installation.
   For example:

   cd /path/to/drupal/root
   composer require drupal/apigee_api_catalog
   

   For more information about installing contributed modules using Composer, read
   how to download contributed modules and themes using Composer.

2. Choose Extend in the Drupal administration menu.
3. Select the Apigee API catalog module.
4. Choose Install.

Firewalls & Domain Whitelisting

The Apigee SmartDocs OpenAPI specification renderer is an Angular application hosted on a Google CDN. If your developers are accessing the documentation behind a firewall you will need to whitelist the following domains so that the SmartDocs Angular library is available to the browser:

• www.gstatic.com
• fonts.googleapis.com
• cdn.jsdelivr.net

If you are not able to meet these requirements, you can change the OpenAPI spec renderer from SmartDocs to a different type.