protoc-gen-twirp-gateway

command module
v0.0.0-...-0c70a75 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 22, 2021 License: MIT Imports: 7 Imported by: 0

README

protoc-gen-twirp-gateway

WARNING: This is alpha quality code, do not use in production.

Generate google.api.HttpRule defined gateways for your Twirp RPC Go services.

Usage

See Google's gRPC transcoding documentation for gRPC examples if you haven't used google.api.HttpRule before.

protoc --go_out="." --twirp_out="." --twirp-gateway_out="." $proto

Motivation

  • Keep your twirp protobuf service definitions grpc and grpc-gateway compatible.
  • Provide RESTful endpoints on serverless plaforms that don't support gRPC such as non GKE Google Cloud Run deployed services.
  • Implement REST, Twirp and gRPC interface endpoints all using the same IDL and concrete service implementation.

TODO

  • Tests.
  • RAML YAML.
  • OpenAPI (Swagger) YAML.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL