- Intro
- Audience
- Before you begin
- Using the sample proxies
- Samples
- Modifying a sample proxy
- Ask questions on the Apigee Community
- Apigee documentation
- Contributing
This repository contains a collection of sample API proxies that you can deploy and run on Apigee X or hybrid.
The samples provide a jump-start for developers who wish to design and create Apigee API proxies.
You are an Apigee API proxy developer, or you would like to learn about developing APIs that run on Apigee X & hybrid. At a minimum, we assume you're familiar with Apigee and how to create simple API proxies. To learn more, we recommend this getting started tutorial.
-
See the full list of Prerequisites for installing Apigee.
-
You'll need access to a Google Cloud Platform account and project. Sign up for a free GCP trial account.
-
If you don't have one, you'll need to provision an Apigee instance. Create a free Apigee eval instance.
-
Clone this project from GitHub to your system.
Most developers begin by identifying an interesting sample based on a specific use case or need. You'll find all the samples in the root folder.
| Sample | Description | Cloud Shell Tutorial |
|---|---|---|
| deploy-apigee-proxy | Deploy Apigee proxy using Apigee Maven plugin and Cloud Build |  |
| deploy-apigee-sharedflow | Deploy Apigee sharedflow using Apigee Maven plugin and Cloud Build | |
| deploy-apigee-config | Deploy Apigee configurations using Apigee Maven plugin and Cloud Build | |
| authorize-idp-access-tokens | Authorize JWT access tokens issued by an Identity Provider | |
| oauth-client-credentials | A sample proxy which uses the OAuth 2.0 client credentials grant type flow | |
| oauth-client-credentials-with-scope | A sample proxy which uses the OAuth 2.0 client credentials grant type flow and limit access using OAuth2 scopes | |
| cloud-logging | A sample proxy that logs custom messages to Google Cloud Logging | |
| basic-quota | A sample which shows how to implement a basic API consumption quota | |
| cloud-run | A sample proxy to invoke Cloud Run Service from Apigee | |
| integrated-developer-portal | This sample demonstrates how to create an Apigee Integrated portal and shows how to expose your API products to its catalog | |
| drupal-developer-portal | This sample demonstrates how to create a Drupal developer portal using the GCP Marketplace and shows how to expose your Apigee API products to its catalog | |
| exposing-to-internet | This sample demonstrates how to expose an Apigee instance to the internet using a Google Cloud external HTTP(S) Load Balancer | |
| json-web-tokens | This sample demonstrates how to generate and verify JSON Web Tokens using the out of the box Apigee JWT policies | |
You can find videos of all the samples in this YouTube playlist
Feel free to modify and build upon the sample proxies. You can make changes in the Apigee management UI or by using our Cloud Code extension for local development in Visual Studio Code. Whichever approach is comfortable for you.
Simply redeploy the proxies for changes to take effect.
Apigee Community is a great place to ask questions and find answers about developing API proxies.
The Apigee docs are located here.
New samples should be added as a root level directory in this repository.
For more details on how to contribute please see the guidelines.
All solutions within this repository are provided under the Apache 2.0 license. Please see the LICENSE file for more detailed terms and conditions.
This is not an officially supported Google product, nor is it part of an official Google product.
If you need support or assistance, you can try inquiring on Google Cloud Community forum dedicated to Apigee.