8ec5a83eec | ||
---|---|---|
.github/workflows | ||
example | ||
example_rack2 | ||
gemfiles | ||
internal/gen/typemap | ||
lib | ||
protoc-gen-twirp_ruby | ||
test | ||
vendor | ||
.gitignore | ||
CONTRIBUTING.md | ||
Gemfile | ||
LICENSE | ||
README.md | ||
RELEASE_NOTES.md | ||
Rakefile | ||
go.mod | ||
go.sum | ||
twirp.gemspec |
README.md
Twirp-Ruby
Twirp is a protocol for routing and serialization of services defined in a .proto file, allowing easy implementation of RPC services with auto-generated clients in different languages.
The canonical implementation is in Golang. The Twirp-Ruby project is the official implementation in Ruby for both server and clients.
Install
Add gem "twirp"
to your Gemfile, or install with gem install twirp
.
To auto-generate Ruby code from a proto file, use the protoc
plugin and the --ruby_out
option (see Wiki page).
No backwards compatible breaking changes, between minor versions(1.10.0)
When upgrading from version 1.9.0 to 1.10.0, note that there is a breaking change in the Twirp::ClientResp#initialize
method. The method now accepts keyword arguments. For more details, refer to this comparison and this issue.
Documentation
Contributing
Releases and changes
See the releases page for latest information about released versions.