API governance glossary

You're viewing Apigee X documentation.
View Apigee Edge documentation.

A

administrator
A role that provides permissions that allow full control of the content and configuration of the registry. An Administrator defines the taxonomies and rules in the API hub.
API governance
The act of establishing and applying policies to channel and regulate growth, resulting in a more organized and consistent API program.
API hub
A place to view all the APIs produced by an enterprise. API hub supports the API discovery journey for internal consumers and invites API producers to add and manage their own API information. This centralized API catalog supports API governance efforts across an API program.
API platform team
A team (or person) that oversees the production and operation of an organization's APIs, often working to help the organization apply standards and processes that allow them to produce more consistent and usable APIs.
API registry
A service that collects descriptions and manages metadata for all of the APIs in an organization.

C

consumer
A person who uses an API in some sort of client application.

D

deployment
A location where an API instance is available. A deployment may be production or pre- production.
developer
A person who writes code, whether that is a service that exposes an API (as a producer) or for a client app that calls that API (as a consumer).
discovery
The process of searching for and finding an API.

E

editor
A user that manages and owns individual APIs.
external channel
A link to an external channel for the API, such as a Developer Portal.

L

lifecycle
The stages an API moves through from concept and design through implementation, operation, deprecation, and retirement. The names of these stages can be customized to conform to the process and nomenclature used in your organization.

P

portal
A portal is a website where APIs are published so that consumers can discover and adopt into their client apps. A portal enables you to manage access by non-Apigee users to your APIs.
producer
One or more people on a team responsible for a service that fulfills responses for client apps' API requests. A producer owns one or more APIs in the provider's catalog.

R

recommended version
The version of a deployment that is recommended to new, internal users. Typically this is the version that is the most stable. Every API must have a recommended version, which cannot be deleted.
revision
A specific, discrete copy of a resource (artifact, deployment, or specification) that represents a content change from the previous (and next if latest) revision in time.
role
A set of permissions that control access to the functions in the user interface. See Roles.

S

score
A numeric indicator of quality whose calculation may be automated through integrations.
specification
A formal description of an API version that ideally leverages an industry standard format, such as OpenAPI or Protocol Buffers.

T

taxonomy
A named list of values that provides categorization options that help to organize a portfolio of APIs.
team
A group of people who collaborate together as consumers or producers and who may share permissions or roles.

V

version
A well-defined interface of an API that provides stability for consuming applications. A version is a container for incremental revisions as the interface or the description evolves.
See also: revision
viewer
A user that can view and use, but not modify, APIs. An API consumer.