Apigee has provided a great set of documentation on how their Edge Gateway can be configured. This documentation does not replace it, but instead will help guide the process and outline some standardizations and guidelines.

Process

Create an API Spec

API Specs are written in the OpenAPI 2.0 format and are very useful for describing an API backend. API Providers will need to create an OpenAPI 2.0 spec which will be added to the Apigee Gateway. This is the initial step before creating an API Proxy.

Create an API Proxy

An API Proxy is the endpoint under https://api.ucsb.edu/ which will actually handle the API call. This is the core piece of functionality that we need for the API to work and everything else is an extension to help manage, secure, and document it. Apigee has multiple ways to create an API Proxy and this will demonstrate how to use some of the auto-generation tooling to get a proxy created quickly and easily. The configuration of the proxy will not be completed within this guide. You will then need to ...

Edit an API Proxy

Once an API Proxy is created there are a number of standard configuration that must be applied to it before it can be used. These standard configurations can be applied in a easy and repeatable manner which have been documented in this guide. This step will get the endpoint ready as an API proxy, which leads to the next step.

Create an API Product

An API Product is the actual "API" that applications can register to use within the Developer Portal. The API Product is actually a security wrapper around the API endpoint which governs which resources are exposed and how they can be interacted with (read vs write). When a developer wants to register their application to use an API, they will be shown a list of API Products to select from.