Stanza Public APIs

This repository contains the Stanza API as Language Independent Interface Types (.proto files) as well as our corresponding REST API (.json files). It is recommended to generate and use language specific Buf Connect or gRPC clients whenever possible.

Generating Swagger files

buf generate --template stanza/hub/v1/buf.gen.yaml --path stanza/hub/v1

This will eventually be automated away.

Generate gRPC Client Libraries

Create a local buf.gen.yaml file in the target repository and generate appropriate language specific client libraries into that repo with:

buf generate https://github.com/StanzaSystems/apis.git

Example buf.gen.yaml (for golang):

version: v1
managed:
  enabled: true
  go_package_prefix:
    default: gen/go
    except:
      - buf.build/googleapis/googleapis
      - buf.build/grpc-ecosystem/grpc-gateway
plugins:
  - plugin: buf.build/protocolbuffers/go
    out: gen/go
    opt: paths=source_relative
  - plugin: buf.build/bufbuild/connect-go
    out: gen/go
    opt: paths=source_relative

Please see Generating Code with Buf documentation for more on buf.gen.yaml.