API resources overview

This page applies to Apigee and Apigee hybrid.

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. Either at the time you register an API or afterwards, you can add and edit API resource attributes to build a rich description of the API.

API hub supports both system-defined and user-defined attributes. Examples of system defined attributes include:

  • API style: An attribute with default values of REST, gRPC, SOAP, and Async API.
  • Target users: The intended users (consumers) of an API
  • Team: The producing team or teams responsible for an API
  • Business unit: The business unit responsible for an API
  • Maturity level: An indication of the API's lifecycle stage

Some system attributes don't have default values. For example:

  • Documentation: A link to documentation for the API
  • Owner: The name and email address for the API's owner

Finally, an API resource can have user defined attributes, which you define in Settings based on your organizational or team needs.