Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apigee/apigee-edge-drupal
The Apigee Edge module enables you to integrate a Drupal 9 or 8 site with Apigee.
https://github.com/apigee/apigee-edge-drupal
api-client apigee composer drupal drupal-8 drupal-9 drupal8
Last synced: 26 days ago
JSON representation
The Apigee Edge module enables you to integrate a Drupal 9 or 8 site with Apigee.
- Host: GitHub
- URL: https://github.com/apigee/apigee-edge-drupal
- Owner: apigee
- License: gpl-2.0
- Created: 2018-04-20T20:36:23.000Z (over 6 years ago)
- Default Branch: 3.x
- Last Pushed: 2024-09-17T11:44:24.000Z (about 2 months ago)
- Last Synced: 2024-09-27T10:41:11.587Z (about 1 month ago)
- Topics: api-client, apigee, composer, drupal, drupal-8, drupal-9, drupal8
- Language: PHP
- Homepage: https://www.drupal.org/project/apigee_edge
- Size: 3.89 MB
- Stars: 32
- Watchers: 24
- Forks: 45
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.txt
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Apigee Drupal module
The Apigee module enables you to integrate Drupal 10 with Apigee Edge or Apigee X.
* Users that register or are added to the Drupal site will be added as developers in Apigee.
* Click on "Apps" in user menu to get keys for the APIs exposed in Apigee.
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:__ enables developers to be organized into teams.
For more details read the [Apigee module documentation](https://www.drupal.org/docs/contributed-modules/apigee-edge).
## Support for Apigee Hybrid Cloud and Apigee X
Support for [Apigee hybrid API](https://docs.apigee.com/hybrid/reference-overview) and [Apigee X API](https://cloud.google.com/apigee/docs/) is now considered production ready.
Apigee X Team APIs is supported by [AppGroups](https://cloud.google.com/apigee/docs/api-platform/publish/organizing-client-app-ownership#appgroup-settings), For more details see [viewing and managing AppGroups](https://cloud.google.com/apigee/docs/api-platform/publish/organizing-client-app-ownership#viewing-and-managing-appgroups).
If you run into any problems, add an issue to our [GitHub issue queue](https://github.com/apigee/apigee-edge-drupal/issues).
Please note that the Monetization APIs are not currently supported on Apigee hybrid/ X.
## Requirements
* The Apigee module requires **Drupal 10.1.x** or higher and PHP 8.1, Drupal 10.x is recommended due to [Drupal 9's EOL timeline](https://www.drupal.org/docs/understanding-drupal/drupal-9-release-date-and-what-it-means/how-long-will-drupal-9-be-supported#s-drupal-9-support-will-end-in-november-2023).
* Drupal'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](https://github.com/apigee/apigee-edge-drupal/blob/3.x/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](https://packagist.org/packages/cweagans/composer-patches) plugin automatically or manually. See [Applying Patches](#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](https://www.drupal.org/project/drupal/issues/2956279). See the related pull request for behat/mink [here](https://github.com/minkphp/Mink/pull/760).
## Installing
1. Install the Apigee module using [Composer](https://getcomposer.org/).
Composer will download the Apigee 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](https://www.drupal.org/docs/develop/using-composer/using-composer-to-manage-drupal-site-dependencies#managing-contributed).
2. Click **Extend** in the Drupal administration menu.
3. Select the **Apigee** module.
4. Click **Install**.
5. Configure the [connection to your Apigee org](https://www.drupal.org/docs/contributed-modules/apigee-edge/configure-the-connection-to-apigee)
## Notes
* If you do not configure the connection between Drupal and Apigee, 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, you should uninstall the Apigee module.
* When you first install the module, existing users in the Drupal site may not have a developer account in Apigee.
You can run [developer synchronization](https://www.drupal.org/docs/contributed-modules/apigee-edge/synchronize-developers-with-apigee-edge)
to make sure Drupal users and Apigee developers are synchronized.
* For migrating Apigee hybrid/ X Teams members in Drupal, you can run [Team synchronization](https://www.drupal.org/docs/contributed-modules/apigee-edge/synchronize-team-with-apigee-edge) to get the Team members information.
## Applying Patches
The Apigee module may require Drupal core or contributed module patches to be able to work properly. These patches
can be applied automatically when Apigee module gets installed but for that your Drupal installation must fulfill
the following requirements:
1. [cweagans/composer-patches](https://packagist.org/packages/cweagans/composer-patches) >= 1.6.5 has to be installed.
2. ["Allowing patches to be applied from dependencies
"](https://github.com/cweagans/composer-patches/tree/1.6.5#allowing-patches-to-be-applied-from-dependencies)
has to be enabled in Drupal's composer.json.
3. Proper [patch level](https://github.com/cweagans/composer-patches/pull/101#issue-104810467)
for drupal/core has to be set in Drupal's composer.json.
You can find the currently required patches, if any, in the Apigee module's [composer.json](https://github.com/apigee/apigee-edge-drupal/blob/3.x/composer.json)
and in the Apigee PHP API Client's [composer.json](https://github.com/apigee/apigee-client-php/blob/3.x/composer.json).
**If you do not have all required patches applied in your Drupal installation you may experience some problems with the
Apigee module.**
## Troubleshooting
* **[File entity](https://www.drupal.org/project/file_entity) module.** If you installed the File entity module then you are going to need the latest patch from [this issue](https://www.drupal.org/project/file_entity/issues/2977747) otherwise you can run into some problems.
## Development
Development is coordinated in our [GitHub repository](https://github.com/apigee/apigee-edge-drupal). The drupal.org issue queue is disabled; we use the [GitHub issue queue](https://github.com/apigee/apigee-edge-drupal/issues) to coordinate development.
## Support
This project, which integrates Drupal with Apigee, is supported by Google.