Skip to content
This repository was archived by the owner on Jun 24, 2025. It is now read-only.

Commit f2597a0

Browse files
committed
Merge branch 'master' of github.com:apigee/api-platform-samples
2 parents 87060f4 + b4bc7c7 commit f2597a0

9 files changed

Lines changed: 29 additions & 24 deletions

File tree

edge-ux/proxy-to-target/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
},
1212
"dependencies": {
1313
"apigeetool": "mukundha/apigeetool-node",
14-
"gulp": "*",
15-
"gulp-util": "^3.0.7"
14+
"gulp": ">3.9.1",
15+
"gulp-util": "^3.0.8"
1616
},
1717
"author": "mukundha@apigee.com",
1818
"license": "ISC"

learn-edge/README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,33 +14,33 @@ The best way to learn Apigee Edge is by doing!
1414

1515
This is the recommended path through the examples. But you can do them in any order you wish. Each sample can be deployed and run independently:
1616

17-
1. [simplest-proxy](./simplest-proxy/README.md)
17+
1. [simplest-proxy](./simplest-proxy/README.md)
1818

19-
>Learn to deploy and call a very simple proxy.
19+
>Learn to deploy and call a very simple proxy.
2020
2121
2. [proxy-to-a-target](./proxy-to-a-target/README.md)
2222

23-
>Get back data from a backend target service.
23+
>Get back data from a backend target service.
2424
2525
3. [apikey-security-1](./apikey-security-1/README.md)
2626

27-
>Secure an API with an API key.
27+
>Secure an API with an API key.
2828
29-
4. [apikey-security-2](./apikey-security-1/README.md)
29+
4. [apikey-security-2](./apikey-security-2/README.md)
3030

3131
>Prevent an API key from being passed to the backend target service.
3232
3333
4. [fault-handling-1](./fault-handling-1/README.md)
3434

35-
>Handle a proxy error and return a custom error message.
35+
>Handle a proxy error and return a custom error message.
3636
3737
5. [fault-handling-2](./fault-handling-2/README.md)
3838

39-
>Learn more about how to do fault handling.
39+
>Learn more about how to do fault handling.
4040
4141
5. [response-cache-1](./response-cache-1/README.md)
4242

43-
>Speed up your proxy performance with a response cache.
43+
>Speed up your proxy performance with a response cache.
4444
4545
6. [response-cache-2](./response-cache-2/README.md)
4646

@@ -49,14 +49,14 @@ This is the recommended path through the examples. But you can do them in any or
4949
6. [extract-json-payload](./extract-json-payload/README.md)
5050

5151
>Extract data from a JSON payload and return the data in custom response headers.
52-
52+
5353
7. [extract-json-payload-2](./extract-json-payload-2/README.md)
5454

5555
>Query for data to extract from a JSON response payload.
5656
5757
7. [extract-xml-payload](./extract-xml-payload/README.md)
5858

59-
>Extract data from an XML request body and set a custom XML response body.
59+
>Extract data from an XML request body and set a custom XML response body.
6060
6161
7. [quota-1](./quota-1/README.md)
6262

@@ -74,7 +74,7 @@ This is the recommended path through the examples. But you can do them in any or
7474
### Prerequisites
7575

7676
1. You need an **Apigee account**. If you don't have an Apigee account, go to [https://login.apigee.com/login](https://login.apigee.com/login), and click Create Account.
77-
2. You must install [apigeetool](https://www.npmjs.com/package/apigeetool). We use apigeetool to deploy the proxies.
77+
2. You must install [apigeetool](https://www.npmjs.com/package/apigeetool). We use apigeetool to deploy the proxies.
7878

7979
`npm install -g apigeetool`
8080

@@ -83,24 +83,29 @@ This is the recommended path through the examples. But you can do them in any or
8383
2. Download or clone the [api-platform-samples](https://github.com/apigee/api-platform-samples) GitHub repo.
8484
6. In a browser, sign in to your [Apigee account](http://apigee.com) and go to the API Management section. It'll be good to keep this browser window open as you work so you can view and trace the Learn Edge proxies in the UI.
8585

86+
**Troubleshooting:** If you've previously tried to run the sample and have
87+
trouble with the script (for example, it's using the wrong organization
88+
or the URL to invoke is incorrect), find and delete `HOME/learn-edge.rc`
89+
on your local file system. Then re-deploy the sample.
90+
8691
That's it! To get started, go to the README for the first example proxy, [simplest-proxy](./simplest-proxy), and follow the instructions. On your filesystem, it is in the folder `api-platform-samples/learn-edge/simplest-proxy`.
8792

8893
### What you'll learn
8994

9095
We try not to clutter the lessons with a lot of explanation and background information. Rather, we expect you to learn by doing, by changing things, and fixing problems. When you complete the series, you will understand:
9196

9297
* The basic capabilities of Apigee Edge.
93-
* Core concepts you'll need to be a successful Edge developer. They include security, fault handling, caching, quotas, and others.
98+
* Core concepts you'll need to be a successful Edge developer. They include security, fault handling, caching, quotas, and others.
9499
* How Edge projects are structured.
95100
* How to do primary Edge development locally, on your laptop, rather than in the UI.
96101
* How to deploy Edge proxies from your laptop to Edge.
97102
* Basic debugging techniques.
98103

99-
**Tip:** If you want to dive deeper into any concept covered in this series, you can go to the [Apigee Edge documentation](http://docs.apigee.com/) and use Search to look up topics (search works very well and even picks up related topics in the [Apigee Community](https://community.apigee.com/index.html)). In a few cases, we'll provide a link if we think it will be especially helpful. You can also check out the Apigee Edge [4-Minute Video](https://www.youtube.com/playlist?list=PLIXjuPlujxxxe3iTmLtgfIBgpMo7iD7fk) series.
104+
**Tip:** If you want to dive deeper into any concept covered in this series, you can go to the [Apigee Edge documentation](http://docs.apigee.com/) and use Search to look up topics (search works very well and even picks up related topics in the [Apigee Community](https://community.apigee.com/index.html)). In a few cases, we'll provide a link if we think it will be especially helpful. You can also check out the Apigee Edge [4-Minute Video](https://www.youtube.com/playlist?list=PLIXjuPlujxxxe3iTmLtgfIBgpMo7iD7fk) series.
100105

101106
### What you won't learn
102107

103-
* A lot of background, text-book style information. You'll learn by deploying and running example code on Apigee Edge. You can always read about features in the official [Apigee Edge documentation](http://docs.apigee.com/).
108+
* A lot of background, text-book style information. You'll learn by deploying and running example code on Apigee Edge. You can always read about features in the official [Apigee Edge documentation](http://docs.apigee.com/).
104109
* All of the possible use cases for Edge.
105110
* All of the features included with Edge.
106111
* All of the possible ways to use the features we introduce.

learn-edge/extract-json-payload-2/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ We assume you've provisioned the Product, Developer App, and Developer as explai
3030

3131
### Deploy it
3232

33-
1. `cd api-platform-samples/learn-edge/extract-json-payload`.
33+
1. `cd api-platform-samples/learn-edge/extract-json-payload-2`.
3434
2. `./deploy.sh`
3535

3636
### Run it

learn-edge/provisioning/setup.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#!/bin/sh
1+
#!/bin/bash
22

33
## Ensure configuration variables have been set.
44
source ../../setup/userconf.sh || exit 1

learn-edge/scripts/deploy_proxy.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
function deploy_proxy {
44
if hash apigeetool 2>/dev/null; then
55
printf "\n\nUsing apigeetool to deploy the proxy to the $env environment in the $org org to the $url url...\n\n"
6-
apigeetool deployproxy -v -o $org -e $env --api learn-edge -L $url -d . -u $username -p $password -V
6+
apigeetool deployproxy -o $org -e $env --api learn-edge -L $url -d . -u $username -p $password -V
77
printf "\nIf the deployment is successful, then your API Proxy is ready to be invoked.\n"
88
printf "\nRun 'invoke.sh'\n"
99
else

learn-edge/service-callout-1/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ We assume you've provisioned the Product, Developer App, and Developer as explai
1616

1717
### Deploy it
1818

19-
1. `cd api-platform-samples/learn-edge/extract-json-payload`.
19+
1. `cd api-platform-samples/learn-edge/service-callout-1`.
2020
2. `./deploy.sh`
2121

2222
### Run it

learn-edge/service-callout-2/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ We assume you've provisioned the Product, Developer App, and Developer as explai
1818

1919
### Deploy it
2020

21-
1. `cd api-platform-samples/learn-edge/extract-json-payload`.
21+
1. `cd api-platform-samples/learn-edge/service-callout-2`.
2222
2. `./deploy.sh`
2323

2424
### Run it

sample-proxies/oauth-advanced/app/templates/login-app/apiproxy/resources/node/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"express-session": "^1.9.1",
1414
"less-middleware": "^0.1.12",
1515
"serve-favicon": "^2.1.6",
16-
"validator": "^1.3.0"
16+
"validator": ">2.0.0"
1717
},
1818
"devDependencies": {},
1919
"scripts": {

sample-proxies/outbound-oauth/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ A demo application that performs a search and renders the results in HTML is inc
6767
1. Sign up for [Microsoft Translator API](http://www.microsofttranslator.com/dev/) access,
6868
and replace the `clientId` and `clientSecret` in `apiproxy/resources/jsc/api-config.js` with your application credentials.
6969

70-
2. Create a cache in the organization and environment you will be deploying the bundle in, using the definition in `twitter-translate-cache.xml`. This is used to cache the Translator API access token across requests. Try the following command:
70+
2. Create a cache in the organization and environment you will be deploying the bundle in, using the definition in `oauth-token-cache.xml`. This is used to cache the Translator API access token across requests. Try the following command:
7171

72-
```curl -v -X POST -H "Content-Type: application/xml" -d @twitter-translate-cache.xml https://api.enterprise.apigee.com/v1/organizations/$ORG/environments/$ENV/caches -u myname:mypass```
72+
```curl -v -X POST -H "Content-Type: application/xml" -d @oauth-token-cache.xml https://api.enterprise.apigee.com/v1/organizations/$ORG/environments/$ENV/caches -u myname:mypass```
7373

7474
* The username and password that you use to login to enterprise.apigee.com.
7575
* The name of the organization in which you have an account. Log in to

0 commit comments

Comments
 (0)