About this guide

This guide describes how to extend, leverage, and customize API Gateway to suit the needs of your environment. For example, this includes topics such as adding a custom filter to API Gateway, accessing configuration values dynamically at runtime, and creating custom scripts to run against API Gateway.

Who should read this guide

The intended audience for this guide is policy developers and system integrators.

Before creating your own custom filter you should understand exactly what message filters are, and how they are chained together to create a message policy. These concepts are documented in detail in the API Gateway Policy Developer Guide.

How to use this guide

This guide should be used in conjunction with the other guides in the API Gateway documentation set.

Before you begin customizing or extending API Gateway, review this guide thoroughly. The following is a brief description of the contents of each section:

Install the code samples – Describes how to install the code samples used in the API Gateway Developer Guide.

Build the code samples – Describes how to build the code samples.

Add a custom filter to API Gateway – Describes several methods for adding custom filters to API Gateway.

Define user interfaces using declarative XML – Describes how to use declarative XML to define Policy Studio user interface dialogs.

Unit test a filter using the Traffic Monitor API – Describes how to unit test a custom filter using the Traffic Monitor API.

Java interfaces for extending API Gateway – Describes several Java interfaces that you can use to extend API Gateway.

Access configuration values dynamically at runtime – Describes how you can use selectors to access configuration values at runtime.

Key Property Store – Introduces the API Gateway Key Property Store.

Entity Store – Introduces the Entity Store and describes how to use the ES Explorer tool.

Debug custom Java code with a Java debugger – Describes how to connect to API Gateway with a Java debugger.

Get diagnostics output from a custom filter – Describes how to add diagnostics output from a custom filter.

Enable API Gateway with JMX – Describes how to manage API Gateway using Java Management Extensions (JMX).

Automate tasks with Jython scripts – Describes the Jython scripts that are provided with API Gateway.

API Gateway REST APIs – Describes the REST APIs exposed by API Gateway.

Declarative UI reference – Details the declarative XML UI elements that can be used to define the user interface of filters and dialogs in Policy Studio.

Related topics

Related documentation

Related Links