API Control Plane Discovery Agent SDK Overview

In API Control Plane, you can connect to other environments, such as AWS, Kong, or Gravitee and discover APIs from those gateways. Using the API Control Plane discovery agent SDK, developers can implement functionality to support custom gateway types.

The API Control Plane discovery agent SDK contains a set of interfaces and classes that enable the independent creation of API gateway integrations.

How the SDK works

An agent built with the SDK runs as a Docker container alongside your gateway. On startup, the agent reads its configuration from a docker-compose.yml file, connects to API Control Plane, and exposes only the capabilities you choose to implement.

Artifacts in Maven

• Controlplane-agent-api contains a library that includes the data model that the API Control Plane uses and interfaces for all the handlers for the capabilities that your gateway supports, such as component discovery and metrics.
• Controlplane-agent-example contains a sample implementation and returns example data.

The SDK is organized around three main areas:

• Configuration — how the agent connects to your gateway (Gateway, GatewayConfiguration, GatewayConfigurationFactory)
• Capabilities — what operations the agent can perform (Handler implementations and CapabilityFactory)
• Plugin loading — how the agent discovers your implementation at runtime (GatewayManager, META-INF/services)

Implementation steps

Complete these steps in order:

1. Implement Gateway and GatewayConfiguration
2. Implement Handlers and Capabilities
3. Implement GatewayManager
4. Compile the agent plugin
5. Create a custom Platform Type
6. Register a gateway and run the agent