Tutorial : Create an API Proxy in Apigee Edge

Google Cloud Apigee Knowledge Hub
1

Hello Everyone,

In this video we will see how to create an API Proxy in Apigee Edge & why we need to create API Proxy with an example.

Why do we need to create an API Proxy ? :

  • Secure:
    • Secure APIs using OAuth Access Tokens, even though your backend doesn’t support it.
  • Scale:
    • Let’s say your backend supports few tens of transaction per seconds, but you would like to scale your API to few hundred / thousands of TPS.
  • Manage:
    • Building Software / APIs is easy but difficult to maintain them in your complex backend systems.
    • Updating backend APIs is complex & time taking.
    • Seamlessly manage multiple APIs / API Methods by creating API Proxy as a layer in Apigee Edge.
  • Analyze:
    • Almost every business today is driven by data. You need to understand data that is flowing in request / response of your APIs.
    • You need to understand who is consuming your services using APIs & what kind of Apps are built by Developers using your APIs.
    • When you create an API Proxy in Apigee Edge by default we capture more than few hundred metrics and give you great reports.
  • Connect:
    • You can create a single API Proxy that talks to multiple APIs get data, mashup and provide the response as a single service.
    • Connect Internal Teams, Partners, Public Developers easily & seamlessly.

Let’s create an API Proxy in Apigee Edge:

It’s free, you can signup here.

Step 1:

Navigate to https://enterprise.apigee.com , Login using Apigee Credentials.

1791-screen-shot-2016-01-13-at-111824-am.png
1791-screen-shot-2016-01-13-at-111824-am.png1431×549 40.4 KB

Step 2 :

You will see dashboard like below if your ORG is activated, otherwise activate the org & wait for the activation email. Generally, it takes few minutes for ORG provision if you are newly registered. Logout and re-login if you have registered recently & waiting for ORG activation.

1792-screen-shot-2016-01-13-at-112115-am.png
1792-screen-shot-2016-01-13-at-112115-am.png1426×786 48.6 KB

Step 3 :

Navigate to APIs → API Proxies to create a new API Proxy in Apigee Edge.

1793-screen-shot-2016-01-13-at-112215-am.png
1793-screen-shot-2016-01-13-at-112215-am.png1424×345 34.9 KB

Step 4 :

Click on + API Proxy button on above screen to create new API Proxy. You will see the screen like below to create a new API Proxy.

1794-screen-shot-2016-01-13-at-112404-am.png
1794-screen-shot-2016-01-13-at-112404-am.png1372×517 57.6 KB

Step 5 :

Update the details as shown in above screenshot. We are going to create an API Proxy for yahoo weather backend API which shows whether information. Fill the details and click on build.

1795-screen-shot-2016-01-13-at-112411-am.png
1795-screen-shot-2016-01-13-at-112411-am.png1371×430 37.1 KB

Step 6 :

Click on the proxy URL, It opens up a new browser window & you can see the response from yahoo weather API. Append ?w=2502254 to the Proxy URL to get “Sunnyvale, CA” weather report.

http://4mv4d-test.apigee.net/weatherinfoapi?w=2502265

uraVKcG
uraVKcG1424×643 59.1 KB

That’s it!! You just created an API Proxy. Watch above video to see how you can improve the performance of your API using Apigee response cache.

Keep us posted.

1 Like
2

@Anil Sagar How can we create API proxy through Apigee Edge Management API not through Apigee Edge Management UI?

please give any references and best-practices guides.

3

@Rajasekhar reddy , You can create the proxy bundle locally & upload it using the Management API Import API Proxy. Alternatively, You can use command like tools like apigeetool.

Hope it helps. Keep us posted moving forward if any.

4

@Anil Sagar @ Google To create API proxies and relevant policies we need to create the folder structure such as apiproxy, and chid folder policies, proxies, and targets. And default.xml files in root folder, proxies and target folder.

Is there any utility/framework wherein I will pass the apiproxy name, target end points and policy types with specific parameters, and it will create those folder structure and xml files required?

My customized application will be able to create the api proxies and assign policies and then call the import API proxy URL of Edge management API.

I would not like to go thru the Edge management UI to create and export it.

Any reference/implementation towards this will help. Thanks

5

This seems like a new question. Can you ask a new question, please?

6

Posted as new question.

https://community.apigee.com/questions/84708/developing-api-proxies-bundle-and-deploying.html

Requesting your help.