Register an API

This page applies to Apigee and Apigee hybrid.

This page shows you how to register an API in API hub.

Before you begin

  1. API hub must be provisioned in a Google Cloud project to which you have access. See Provision API hub.

  2. In the Google Cloud console, on the project selector page, select the project in which API hub is provisioned.

    Go to project selector

Register an API

When you register an API with API hub, you create and store an entity that represents the API. We call this entity an API resource. API resources stored in API hub are searchable and provide detailed operational and descriptive information about the API. To learn more, see API resources overview.

  1. In the Google Cloud console, go to the APIs page in Apigee API hub.

    Go to API hub
  2. Click Register API. The Register an API form appears.
  3. In the General details section of the form, enter a display name. The display name is simply a name of your choice that will appear in the user interface after you register the API. This attribute is required.
  4. Click Continue.
  5. The Owner information form opens.
  6. The owner information fields are optional. For now, leave them blank and click Continue.
  7. The Additional details form opens.
  8. In the Description field, enter a brief description of the API. Description is an optional field.
  9. Skip the remaining fields and click Continue.
  10. The User defined attributes form opens.
  11. Provide values for any of the attributes you wish. If there are no attributes, that means none have been created yet. See Create user-defined attributes.
  12. Skip API metrics.
  13. Click Register.

You have created an API resource in API hub. You can always return to an API resource to edit it later.

View API details

After you register an API, you can view its details.

  1. In the Google Cloud console, go to the APIs page in Apigee API hub.

    Go to API hub
  2. Find the API you just registered in the list of registered APIs. If you don't see it, type the name of the API in the Filter.
  3. Click the API name to view its details.

In the next quickstart you will create a version for the API.

Next step

Create a version