You're viewing Apigee Edge documentation.
View Apigee X documentation.
For those who want more control over the experience provided by the developer portals integrated into Apigee Edge, Drupal 8/9 provides a powerful open-source, enterprise-level content management system (CMS). Using Apigee's modules for Drupal 8/9, you can build a fully customized developer portal with greater flexibility and control over the developer experience. Because the Drupal 8/9 projects and these modules are open-source, you can extend and contribute to their development and leverage the knowledge of the Apigee and Drupal communities.
Get up and running quickly with Apigee Kickstart
The fastest way to get a developer portal site up and running with Apigee Edge is to use the Apigee Developer Portal Kickstart. Apigee Developer Portal Kickstart is a Drupal distribution that enables you to quickly evaluate using Drupal 8/9 to create an Apigee developer portal. The Kickstart bundles together all of the open source Apigee Drupal modules and libraries that you need to create a portal, configure a connection to Apigee Edge, showcase your API products, and publish your API reference documentation.
Instructions for installing the Kickstart distribution can be found on Drupal.org at Apigee Developer Portal Kickstart. The Kickstart installer will prompt you for all the information needed to install Drupal 8 or 9 core, configure your connection to Apigee Edge, and get your site up and running with a customizable theme. The Kickstart also includes preconfigured Drupal page entities for your developer portal homepage, API catalog page, and "Get Started” page. Modules for FAQs, Blogs and Forums to build your developer community are also included.
Use Kickstart with Apigee Edge for Private Cloud
You can also use the Kickstart installation profile to install a Drupal 8/9-based developer portal using CentOS 7/RHEL 7. This is the recommended path for customers who prefer a self-managed option for hosting a developer portal on local servers. The developer portal created with this installation can connect to an org in Apigee Edge for Private Cloud or an org in the public cloud. For more installation instructions, see Use Kickstart with Apigee Edge for Private Cloud.
Customize your developer portal
The Kickstart distribution includes a customizable home page, “Get Started” page, and API catalog page. Each of these pages can be modified to reflect your company’s brand, logo, and customized developer experience.
- To customize the logo and color scheme of your developer portal, see Customize your developer portal.
- To create new content on your portal pages, see Edit the content and layout of your pages.
- To get started with FAQs, Blogs, or Forums, see Create an FAQ.
For additional customizations or page development, refer to the following sources:
- Drupal 8 Documentation
- Drupal 9 Documentation
- Drupal Community
- Third-party with expertise in Drupal 8/9
Publish your API Documentation with the Apigee API Catalog
Apigee’s API Catalog module lets you document your APIs in your Drupal 8/9 developer portal using OpenAPI specifications and Apigee SmartDocs. Publishing API documentation to your portals makes it easy for developers to learn, test, and evaluate your APIs.
For more information on using the integrated Apigee API Catalog with SmartDocs in your Drupal 8/9 developer portal, see Document your APIs.
Choose your hosting provider
Using the open source Apigee Drupal 8/9 modules provides you with complete control over the developer experience in your portal. With this self-managed option, you are responsible for hosting and maintaining the portal sites leveraging these modules. You can choose a provider to manage and host your developer portal, such as Pantheon, Acquia, or another provider.
For more information on working with Pantheon to host your Drupal 8/9 developer portal, see Pantheon powers Apigee Drupal-based Developer Portals.
For more information on working with Acquia to host your Drupal 8/9 developer portal, see Apigee and Acquia partner together to deliver development portals.
About the Apigee modules supported for Drupal 8/9
The following table summarizes the Drupal 8/9 projects that are available for use with Apigee and their corresponding GitHub Issue Queues for reporting issues. Contributions are appreciated, as outlined in the contribution guidelines for each project.
|Apigee Edge||Enables you to integrate Drupal 8/9 with Apigee Edge. Includes the following submodules:||Report issue|
|Apigee Edge Client Library for PHP||Makes it easy to develop PHP clients that call the Apigee Edge API.||Report issue|
|Apigee Monetization||Enables you to create a developer portal for an Apigee Edge monetized organization. Includes the following submodule:
|Apigee Developer Portal Kickstart||Enables you to get started quickly using Drupal 8/9 to create an Apigee developer portal. The Kickstart distribution includes Drupal 8 or 9 core, Apigee Edge, the Apigee Edge Client Library for PHP, the Apigee API Catalog, Apigee Monetization, and customizable themes and templates.||Report issue|
|Apigee API Catalog||Enables you to document your APIs using OpenAPI specifications and SmartDocs.||Report issue|