Skip to content

API Registry Applications

Jump to bottom
Tim Burks edited this page Oct 7, 2022 · 4 revisions

What can we do with an API registry?

There are many things that we would like to automate using an API registry. Here are some examples:

  • Evaluate APIs for conformance to API style guides.
  • Deploy services to Google Cloud Run (or other platforms) and store descriptions of these deployments in the registry.
  • Configure API proxies to serve APIs listed in the registry, storing the new endpoints as deployments in the registry.
  • Run protoc to compute FileDescriptorSets, store them in the registry, and use them to configure proxies (e.g. envoy, grpc-gateway).
  • Generate OpenAPI specs for proxied APIs using protoc and protoc-gen-openapi. Store the generated specs in the registry.
  • Run other Protocol-buffer based tools including client library generation, CLI generation, and documentation generation, and store these results in the registry or in external systems.
Clone this wiki locally