Plugins overview

This page applies to Apigee and Apigee hybrid.

Plugins

Plugins enable API hub to connect and ingest API metadata from various Google Cloud services and API gateways where your APIs are managed or defined. They simplify and enhance the process of bringing your API metadata directly into API hub.

Plugins serve as the underlying framework or capability that allows API hub to understand and integrate with different API management platforms and sources. They define how API hub can connect to a particular data source.

Plugin instances

A plugin instance represents a configured and active connection between API hub and a specific API data source, facilitated by its associated plugin. It stores the unique configuration details required to connect to the data source, including connection credentials, curation settings, and any data import schedules. Each plugin instance serves as the entry point for collecting API metadata from its designated source.

Plugin instances are the configured deployments of a plugin. The actual ingestion of data and the registration of APIs as API resources in API hub is managed through plugin instances. Each instance serves as an active entry point for metadata collection from its designated source.

Depending on the source, plugin instances are created in the following ways:

  • Automatic creation: When you associate a Google Cloud runtime project with API hub, API hub automatically creates a plugin instance in the background for that specific gateway service. For more information, see Auto-register APIs.
  • Manual creation: For third-party and custom gateways, you can explicitly create plugin instances that establish a configured connection to your gateways to manually bring in metadata. For more information, see Create plugin instance and Create custom plugins.

Plugin types and supported API sources

The following plugin types are supported in API hub:

Plugin type Description Supported API sources
Google Cloud plugins These plugins are created and maintained by API hub to integrate with specific Google Cloud services and gateways. Plugin instances for these plugins are created automatically when you associate a Google Cloud runtime project with API hub. For more information, see Manage project associations.

  • Apigee and Apigee hybrid
  • API Gateway
Third-party plugins These plugins enable you to connect with third-party gateways and bring your API metadata to API hub. You can create and manage plugin instances for these plugins from the API hub > Settings > Plugins page. For more information, see Create plugin instance.

  • Apigee Edge Public Cloud
  • Apigee Edge Private Cloud (OPDK)
Custom plugins These plugins enable you to connect with your custom on-premises or multi-cloud to API hub. You can create and manage plugin instances for these plugins from the API hub > Settings > Plugins page. For more information, see Create custom plugins.

    -

Plugin data ingestion methods

The following data ingestion methods are available for plugins:

  • Push-based ingestion: the connected data source actively sends (pushes) API metadata updates to API hub as changes occur. This method allows for more real-time synchronization of API metadata. All new Apigee, Apigee hybrid, Apigee Edge Public Cloud, and Apigee Edge Private Cloud plugins are created with push-based ingestion by default.
  • Pull-based ingestion: API hub periodically polls the connected data source to retrieve API metadata.

What's next