Auto-register APIs from Google Cloud projects

This page applies to Apigee and Apigee hybrid.

This page describes how to automatically register APIs from Google Cloud projects to API hub. This auto-registration process enables API hub to register API resources from multiple Google Cloud services, ensuring that all your APIs are captured in the central repository and that your API data remains synchronized with your API deployments.

How auto-registration works

The operation to automatically register APIs from Google Cloud projects to API hub is triggered when you attach a runtime project to API hub. Attaching a runtime project establishes a project association between the Google Cloud project and API hub. During this process, API hub automatically discovers deployed APIs within the project and creates the necessary plugin instances in API hub to manage data ingestion.

Supported Google Cloud services

Auto-registration is currently supported for the following Google Cloud services:

Google Cloud service Ingested data
Apigee and Apigee hybrid Deployed API proxies and their associated OpenAPI specifications
API Gateway Gateway definitions and managed endpoints

Project associations and plugins

When you provision API hub as part of Apigee provisioning, it automatically identifies and attaches any associated Apigee runtime projects. This automatically creates an Apigee and hybrid plugin instance by default in API hub and ingests any deployed API proxies from Apigee.

If you manually attach any additional Apigee runtime projects (Apigee or Apigee hybrid), API hub offers an option to import additonal API metadata. When this option is selected, API hub automatically creates the necessary plugin instance to manage the metadata import. These plugin instances are key to managing the connection and data ingestion for the auto-registration process.

Auto-discovery of OpenAPI specs from Apigee proxies

To simplify API documentation and maintain synchronization with your Apigee proxy deployments, API hub automatically discovers and ingests valid OpenAPI specifications (OAS) when they are included in your Apigee API proxy resources.

When a proxy is deployed in your Apigee runtime project (Apigee or Apigee hybrid), API hub automatically detects the presence of a valid OpenAPI spec in the proxy's resources folder. API hub then ingests and parses the spec, runs linting for validation, and uses the spec to populate the API's documentation, including its operations. This ensures that the API definition in API hub is always consistent with the deployed proxy in your Apigee runtime project.

Note: Auto-discovery of OAS happens irrespective of whether you attach an Apigee runtime project to API hub or if your Apigee runtime project is automatically attached to API hub as part of Apigee provisioning.

Project associations scheduler

API hub periodically (once in six hours) runs a scheduler that connects to your Apigee project, and gets the latest proxy definitions. For the projects that are newly attached, the scheduler gets all the proxy definitions, and then registers them in API hub. And for the existing projects, the scheduler gets only the changes made to the proxy definitions, and then accordingly updates the proxy information in API hub.

Considerations

Consider the following when attempting to attach Apigee runtime projects:

  • All endpoints imported from Apigee will be given an https:// prefix by default.
  • Proxies that aren't deployed in any environment, aren't fetched from the project.
  • Only proxies that are deployed in an environment are fetched. And the environment must be a part of an environment group.
  • Additional attributes representing the Apigee instance type (Apigee X and Hybrid Environment and Apigee X and Hybrid Organization) are automatically created and added to any proxy API deployments that are imported.
  • If the Apigee API isn't enabled for a runtime project, API hub can't auto-register or import the API proxies.

Limitations

What's next