The Registry API allows teams to track and manage machine-readable descriptions of APIs.
We’ve found that many organizations, including ours, are challenged by the increasing number of APIs that they make and use. The Registry API is a structured approach to organizing information about APIs. Machine-readable API specs are key, but we also want to track APIs that lack specs, and we also want to have a way to store API-related metadata that doesn’t fit well in specs.
The Registry API (protocol documentation) presents a simple resource hierarchy for API information. All APIs are tracked in a container called a project. APIs contain versions, and versions contain specs. Information about where API services are hosted is tracked in collections of deployment resources under APIs.
We use the following convention for naming resources:
projects/{project_id}/locations/{location_id}/apis/{api_id}/versions/{version_id}/specs/{spec_id}
The locations/{location_id} segment is included to match Google Cloud
resource naming; currently only the global location is supported.
Specs can be of any format, and spec formats are specified with a mime_type
field in the spec record. Metadata can be associated with APIs, versions, and
specs using maps of key-value pairs attached to these resources, and larger
metadata can be stored in artifacts associated with projects, APIs,
versions, and specs. Artifacts are binary blobs with associated mime_type
values that can optionally refer to Protocol Buffer message types. Depending on
the entities they are associated with, artifacts can have any of the following
resource names:
projects/{project_id}/locations/global/artifacts/{artifact_id}
projects/{project_id}/locations/global/apis/{api_id}/artifacts/{artifact_id}
projects/{project_id}/locations/global/apis/{api_id}/versions/{version_id}/artifacts/{artifact_id}
projects/{project_id}/locations/global/apis/{api_id}/versions/{version_id}/specs/{spec_id}/artifacts/{artifact_id}
projects/{project_id}/locations/global/apis/{api_id}/deployments/{deployment_id}
For more information on mime_type values, see Media Types.
The Registry API is a gRPC service that closely follows the guidelines in the Google API Improvement Proposals. This includes following standards for pagination, reading across collections, filtering for all collections, optional partial responses, resource revisions for specs, and support for generated client libraries and HTTP transcoding.
For more information, see the README at the root of the project and other README files scattered throughout the repository. For questions or concerns, feel free to contact the repo owners directly or to use the Issues area. Thanks for reading!