Document your APIs

The Kickstart distribution also includes the Apigee API Catalog module, which lets you document your APIs in your Drupal developer portal. Publishing API documentation to your portals makes it easy for your developers to learn, test and evaluate your APIs. The Apigee API Catalog module transforms valid OpenAPI specifications in JSON or YAML format into easy-to-use documentation rendered with SmartDocs.

When you create your portal using the Apigee Developer Portal Kickstart distribution, the Apigee API Catalog module will be installed for you.  There are a few Kickstart-specific Apigee API Catalog features available as part of the installation, including:

• An available image field to use in your API Doc entities.
• A customized view that lists your API Docs, accessible at /apis.
• A "category" vocabulary for filtering your API Docs at /apis.
• Six examples of API Doc demo content.
• Custom theming of your API Docs and landing page.

For more information on using the Apigee API Catalog module to describe your APIs, see the Apigee API Catalog documentation.