Send Docs Feedback

Samples reference

The Apigee Edge API samples contains the sample API proxies, policies, code, and tools that illustrate the capabilities of Apigee Edge API Services described below.

For instructions on using the samples, see Using the sample API proxies.

Learn by doing

Want to get your hands dirty in a hurry and start building a solid knowledge base about Apigee Edge? We have a library of "learn-edge" samples in GitHub that let you quickly deploy, invoke, and trace some sample proxies, starting with the very simplest proxy and moving on to proxies that illustrate API key validation, quota, response caching, fault handling, and more.

Once you clone the repo and set up your environment (takes just a few minutes), you can try out each sample in less than a minute. And because each sample creates a new revision of the same proxy, your environment won't get cluttered with a lot of samples. You can switch revisions, redeploy a different revision in the management UI, and look at the proxy code any time. The readme for each sample also gives you a brief rundown of what the sample is doing and how it's set up.

Give it a try!


Imagine you're walking around downtown, and you're getting hungry. You pull out your smartphone and launch an app that gives you a list of food trucks (or street carts), shows you where they are, and lets you see their menus. In a few minutes, you've found some incredible street food. Yum.

StreetCarts is an example of how that scenario might come to life. Built on Apigee, StreetCarts is an HTTP-based API that lets you create and view food truck data (which could be surfaced in an app). The sample contains API proxies that implement security and traffic management, and it uses API BaaS as a data store. A client makes calls to an API proxy (such as 'get me a list of food trucks'), and the API proxy grabs the data from API BaaS and returns it to the client. The API also lets you create food trucks and menus, and it automatically sets permissions so that only food truck owners can update their own data.

StreetCarts is a full end-to-end sample that illustrates the power Edge as an API management and data storage solution. It provides scripts for deploying the API proxies into your own Edge organization, creates the Edge artifacts necessary for the sample to work, and populates the API BaaS data store. It also provides Postman collections for executing calls to StreetCarts.

For details and instructions, go to

You can also read multiple articles about the project in the Apigee Community. (Seach for 'streetcarts'.)

Doc cookbook samples

A set of samples are provided for the API proxy cookbook topics.

Name Description Policy Types Resources
javascript-cookbook Demonstrates a simple JavaScript snippet that adds HTTP headers from variables, transforms an XML-formatted weather report from JSON to XML, and trims content down for mobile clients.



javascript-mashup-cookbook A complete JavaScript application that calls to public APIs, combines results, and generates an enriched response for the client app. (Note: this API proxy implements the same functionality as the policy-mashup, demonstrating that the same problem can be addressed using different techniques.) Javascript MashItUp.js
java-cookbook Looks up a weather forecast using Java written to the JavaCallout API. JavaCallout
policy-mashup-cookbook A complete application that uses policy composition to call two public APIs, combines results, and generates an enriched response for the client app. (Note: this API proxy implements the same functionality as the javascript-mashup, demonstrating that the same problem can be addressed using different techniques.) AssignMessage
nodejs-baas-cookbook Demonstrates how to create a simple BaaS solution using Node.js on Apigee Edge. The Node.js code orchestrates calls to the API BaaS data store, executes custom logic, and returns appropriate responses. none


Sample API proxies

The following API proxies are available in this distribution.


These are newly added samples:

Name Description Policy Types Resources
regex-protection The regular expression threat protection policy can protect your backend APIs and microservices from SQL injection attacks.

Regular Expression Protection

oauth-validate-key-secret You are implementing the OAuth Password grant type flow. You need to validate both the application client key and secret on Edge before calling an outside Identity Provider to validate the user's credentials. OAuthV2, others N/A
condition-pattern-matching This proxy lets you easily try out and test conditional statements in an API proxy flow. AssignMessage N/A


These are previously existing samples:

Name Description Policy Types Resources
access-entity Shows how to retrieve profiles for entities from the Apigee Edge datastore. AssignMessage


This sample contains two API proxies that integrate API services and APIBaaS authentication and authorization. One proxy distributes access tokens and the other validates access tokens. The access token for APIBaaS is embedded in the API services access token, enabling seamless mediation from the API proxy to the API backend on APIBaaS. Note that these proxies are intended to be more functional than instructive. If you are just learning how to build API proxies, skip this one. none none
apikey Implements simple API key validation VerifyAPIKey
async-callout Demonstrates a simple asynchronous callout using the JavaScript httpClient. Javascript assemble_reponse.js
base64encoder Demonstrates how to call JavaScript includes from JavaScript resources in API proxies. AssignMessage
conditional-policy Implements simple conditional policy enforcement. When a request contains an HTTP header responsetime:true, a policy executes a Python script that adds a set of performance metrics to the response message, as HTTP headers Script (Python)
dynamic-endpoint Implements simple conditional routing in a slightly more complex scenario, that defines two URLs and one default route. none none
jira-release-notes This is the API proxy used by the Apigee doc team to generate release notes from Jira. JSONToXML
json-patch-app-services This sample enables PATCH requests for the Apigee API BaaS API, which does not support PATCH natively, using a combination of GET and PUT. Javascript
kerberos-credential-mediation This sample shows how to perform Kerberos Credential Mediation on Apigee Edge. JavaCallout Java JAR file
oauth-advanced A complete, working example of the authorization code grant type flow, with Apigee Edge as the authorization server. 


Many others...

see the example code
oauth-client-credentials Demonstrates a fully functional OAuth 2.0 token endpoint configured for the client credentials grant type. GenerateAccessToken none
oauth-login-app Deprecated. We recommend that you look at the oauth-advanced sample instead.    
oauth-validate-key-secret Illustrates a technique for validating the client's key and secret before calling an identity provider to validate user credentials in the password grant type flow.  OAuthV2
oauth-verify-accesstoken Demonstrates an API proxy that is configured to validate OAuth 2.0 access tokens and verify Quota. VerifyAccessToken
oauth10a-3legged Demonstrates an OAuth 1.0a three-legged configuration. GenerateAceessToken
outbound-oauth Uses the Microsoft Azure translator API to translate tweets. To do so, it makes an outbound call to obtain an OAuth access token, and then caches the token using the API Services caching policies, reusing the cached token each time an outbound call is made. Also, includes a demonstration browser app used to invoke the API proxy. AssignMessage
pagination Paginates an XML response message based on limit and offset parameters provided by the client AssignMessage
response-cache Demonstrates how to cache weather forecasts on Edge for 10 minutes. ResponseCache
simple-python Demonstrates a simple scenario of attaching a python script in the
response that adds a header value to it.
Script (Python)
soap Demonstrates an XSL transformation that rewrites a WSDL file in response to a request with the query parameter ?wsdl. AssignMessage
Script (Python)
streaming Demonstrates an HTTP streaming configuration. none none
target-reroute Demonstrates using JavaScript to dynamically select a target URL based on the the content of a request message. ExtractVariables
twitter-mobile-timeline Demonstrates how to use JavaScript to strip out unneeded parameters from tweets, resulting in a streamlined Twitter timeline that is friendly for resource-constrained mobile devices. AssignMessage
twitter-oembed Transforms timeline responses (e.g. from statuses/user_timeline.json) into an oEmbed response that contains the timeline data as rich HTML content. AssignMessage
variables Demonstrates how to extract and set variables based on transport and JSON and XML message content. AssignMessage
xmltojson Converts a Yahoo API weather report from XML to JSON. XMLToJSON

Reference and Tools

In addition to the doc cookbook samples and sample proxies in the tables above, the Edge GitHub samples also contain these resources:


XML schema files that you can use as a reference when configuring API proxies, policies, API products, and developer and app profiles.


Contains a deployment tool,, that imports an API proxy to an organization on Apigee Edge and then deploys it to the environment specified.


The organization snapshot tool retrieves organization settings, including developers, API products, virtual hosts, key/value maps, etc. It can be used to backup the details of an organization, or to discover the settings in an organization.


If you're a coder, Apigee-127 get you up and coding API proxies with Node.js and Swagger. You can also find a127 samples on GitHub:

Share your experience

Share your experiences on the Apigee Developer Forum.

Help or comments?