Understanding APIs and API proxies (original) (raw)

You're viewing Apigee Edge documentation.
Go to theApigee X documentation. info

Apigee Edge lets you easily and quickly build RESTful APIs that can be consumed by app developers. You expose APIs on Edge by building API proxies that act as managed 'facades' for backend services. This topic discusses the relationship between APIs and API proxies on Apigee Edge.

Video: Check out this short video for an introduction to API proxies.

What is an API?

An API is an interface that makes it easy for one application to 'consume' capabilities or data from another application. By defining stable, simplified entry points to application logic and data, APIs enable developers to easily access and reuse application logic built by other developers. In the case of 'Web APIs', that logic and data is exposed over the network.

Since applications that consume APIs are sensitive to changes, APIs also imply a 'contract'. The contract provides some level of assurance that, over time, the API will change in a predictable manner.

Apigee Edge enables you to build APIs and if you have APIs already, expose them directly, while adding a management and visibility layer. If you have HTTP enabled services, such as SOA-based Web services, they can also be exposed as APIs via Apigee Edge.

Edge also enables you to build APIs by implementing applications hosted on the API Services platform--with no backend service involved. You can build these applications in JavaScript, Java, and on Node.js.

What is an API proxy?

You expose APIs on Apigee Edge by implementing API proxies. API proxies decouple the app-facing API from your backend services, shielding those apps from backend code changes. As you make backend changes to your services, apps continue to call the same API without any interruption.

In an API proxy configuration, there are two types of endpoints:

ProxyEndpoint: Defines the way client apps consume your APIs. You configure the ProxyEndpoint to define the URL of your API proxy. The proxy endpoint also determines whether apps access the API proxy over HTTP or HTTPS. You usually attach_policies_ to the ProxyEndpoint to enforce security, quota checks, and other types of access control and rate-limiting.
TargetEndpoint: Defines the way the API proxy interacts with your backend services. You configure the TargetEndpoint to forward requests to the proper backend service, including defining any security settings, HTTP or HTTPS protocol, and other connection information. You can attach policies to the TargetEndpoint to ensure that response messages are properly formatted for the app that made the initial request.

You can visualize API proxies as shown by the graphic below:

HTTP requests enter through the proxy request endpoint, are passed to the target request endpoint,
and then sent to the backend services. HTTP responses enter through the target response endpoint, are
passed to the proxy response endpoint, and then back to the client.

How do you create an API proxy?

An API proxy consists of a bundle of XML configuration files and code (such as JavaScript and Java). Apigee provides several ways for you to create API proxies, including:

Using the Edge management UI to define an API proxy in a Graphical User Interface (GUI). For more, see Build a simple API proxy.
Creating XML files, along with any other supporting files, that define your API proxy and then importing them into Edge.
Using the Edge management API to create your API proxies by making a series of REST requests to Edge.
Deploy a Node.js application as a proxy. See Deploying a standalone Node.js app.

What is a policy?

Edge enables you to control API behavior without writing any code by using policies. A policy is like a module that implements a specific, limited management function as part of the proxy request/response flow. Policies are designed to let you add common types of management capabilities to an API easily and reliably. Policies provide features like security, rate-limiting, transformation, and mediation capabilities, saving you from having to code and maintain this functionality on your own.

Create your first API proxy

Apigee provides a set of tutorials that you can use to create your first API. Start with theBuild your first API proxy.