README.md

protoc-gen-connect-openapi

protoc-gen-connect-openapi generates OpenAPI YAML files for Connect from Protocol Buffers definition.

⚠️ protoc-gen-connect-openapi supports OpenAPI 3.0.

Usage

0. Install and configure buf

1. Install protoc-gen-connect-openapi

go install github.com/s-takehana/protoc-gen-connect-openapi@latest

2. Create a OpenAPI template

info:
  title: Example API
  version: 0.1.0

3. Configure a buf.gen.yaml file

version: v1
plugins:
  - name: connect-openapi
    out: .
    opt:
      - template=path/to/protoc-gen-connect-openapi_template.yaml

4. Execute buf

buf generate