Skip to content
The Apigee Edge module enables you to integrate a Drupal 8 with Apigee Edge.
PHP Other
  1. PHP 97.7%
  2. Other 2.3%
Branch: 8.x-1.x
Clone or download
cnovak Merge pull request #230 from cnovak/drush_create_role
Drush command to create Apigee Edge role
Latest commit c564d04 Dec 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
.travis Merge pull request #230 from cnovak/drush_create_role Dec 19, 2019
config
console/translations/en Add more detail to help for force command Dec 16, 2019
css
images Add basic theming to the app creation and listing pages. Jan 12, 2018
js Generalized app list builder. Jan 7, 2019
modules Merge 8.x-1.x-hybrid. Dec 5, 2019
src Merge pull request #230 from cnovak/drush_create_role Dec 19, 2019
templates
tests
.editorconfig
.gitattributes GH: Identify Drupal specific file types as PHP. Apr 10, 2019
.gitignore Update issue templates and code of conduct Jun 5, 2019
.travis.yml
CHANGELOG.txt Add changelog Mar 19, 2019
CODE_OF_CONDUCT.md
CONTRIBUTING.md [#268] Fixing tests and documenting testing w/Hybrid org. Nov 4, 2019
LICENSE.txt Adding release preparation artifacts Mar 26, 2018
README.md
apigee_edge.config_translation.yml
apigee_edge.info.yml Bump minimum Drupal core requirement May 29, 2019
apigee_edge.install [#291] Highlight "D8P" solution for hybrid being in alpha. Nov 21, 2019
apigee_edge.libraries.yml
apigee_edge.links.action.yml Deprecate EdgeEntityListBuilder::getAddEntityLink(). Jan 16, 2019
apigee_edge.links.menu.yml
apigee_edge.links.task.yml #189 Move API product access tab May 4, 2019
apigee_edge.module [#156] Fix phpcs notice Nov 4, 2019
apigee_edge.permissions.yml
apigee_edge.routing.yml
apigee_edge.services.yml
composer.json
console.services.yml
drush.services.yml
phpcs.xml.dist

README.md

Apigee Edge Drupal module

The Apigee Edge module enables you to integrate Drupal 8 with Apigee Edge:

  • Users that register or are added to the Drupal site will be added as developers in Apigee Edge.
  • Click on "Apps" in user menu to get keys for the APIs exposed in Apigee Edge.

This module includes the following submodules:

  • API product RBAC: enables administrators to configure access permissions to API products.
  • Debug: enables administrators to configure and manage Apigee debug logs.
  • Teams (Experimental): enables developers to be organized into teams.

For more details read the Apigee Edge module documentation.

Following the same concept of Drupal 8 Experimental modules, some submodules are marked as "Experimental". They are provided for evaluation and testing purposes but are still considered to be in development. Experimental modules are included in the "Apigee (Experimental)" package on the "Extend" page of a Drupal site (/admin/modules).

Support for Apigee Hybrid Cloud: Alpha Release

Support for Apigee hybrid API has been added but is considered to be an alpha. If you run into any problems, add an issue to our GitHub issue queue. Please note that Team APIs and Monetization APIs are not currently supported on Apigee hybrid.

Requirements

  • The Apigee Edge module requires Drupal 8.7.x or higher and PHP 7.1 or higher.
  • Drupal 8's minimum requirement is phpdocumentor/reflection-docblock:2.0.4 but at least 3.0 is required by this module. If you get the error "Your requirements could not be resolved to an installable set of packages" it may be because you are running reflection-docblock version 2. You can update phpdocumentor/reflection-docblock with the following command: composer update phpdocumentor/reflection-docblock --with-dependencies.
  • Check composer.json for any required patches. Patches prefixed with "(For testing)" are only required for running tests. Those are not necessary for using this module. Patches can be applied with the cweagans/composer-patches plugin automatically or manually. See Applying Patches section below.
  • (For developers) The locked commit from behat/mink library is required otherwise tests may fail. This caused by a Drupal core bug. See the related pull request for behat/mink here.

Installing

  1. Install the Apigee Edge module using Composer. Composer will download the Apigee Edge 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_edge
    

    For more information about installing contributed modules using composer, see the official documentation.

  2. Click Extend in the Drupal administration menu.

  3. Select the Apigee Edge module.

  4. Click Install.

  5. Configure the connection to your Apigee org

Notes

  • If you do not configure the connection between Drupal and Apigee Edge, you will not be able to register developers on the site and may cause other issues with Drupal core functions. If you do not plan to configure the connection between Drupal and Apigee Edge, you should uninstall the Apigee Edge module.
  • When you first install the module, existing users in the Drupal site may not have a developer account in Apigee Edge. You can run developer synchronization to make sure Drupal users and Apigee Edge developers are synchronized.

Applying Patches

The Apigee Edge module may require Drupal core or contributed module patches to be able to work properly. These patches can be applied automatically when Apigee Edge module gets installed but for that your Drupal installation must fulfill the following requirements:

  1. cweagans/composer-patches >= 1.6.5 has to be installed.
  2. "Allowing patches to be applied from dependencies " has to be enabled in Drupal's composer.json.
  3. Proper patch level for drupal/core has to be set in Drupal's composer.json.

You can find the currently required patches, if any, in the Apigee Edge module's composer.json and in the Apigee Edge PHP API Client's composer.json.

If you do not have all required patches applied in your Drupal installation you may experience some problems with the Apigee Edge module.

Troubleshooting

  • File entity module. If you installed the File entity module then you are going to need the latest patch from this issue otherwise you can run into some problems.

Development

Development is coordinated in our GitHub repository. The drupal.org issue queue is disabled; we use the GitHub issue queue to coordinate development.

Support

This project, which integrates Drupal 8 with Apigee Edge, is supported by Google.

You can’t perform that action at this time.