Twirp is a framework for service-to-service communication emphasizing simplicity and minimalism. It generates routing and serialization from API definition files and lets you focus on your application's logic instead of thinking about folderol like HTTP methods and paths and JSON.
Twirp is similar to gRPC, but without the custom
HTTP server and transport implementations: it runs on the standard library's
extremely-well-tested-and-high-performance net/http Server. It can run on HTTP
1.1, not just http/2, and supports JSON serialization for easy debugging.
Along the way, you get autogenerated clients and a simple, smart framework for passing error messages. Nice!
For more on the motivation behind Twirp (and a comparison to REST APIs and gRPC), the announcement blog post is a good read.
Documentation
Implementations in other languages
This repo contains the generator and runtime library for the Go implementation.
Here is a list of some third-party implementations in other languages.
| Language | Clients | Servers | Repository |
|---|---|---|---|
| Python3 | ✓ | ✓ | github.com/verloop/twirpy |
| Java | ✓ | ✓ | github.com/fajran/protoc-gen-twirp_java_jaxrs |
| Java | ✓ | github.com/devork/flit | |
| JavaScript | ✓ | github.com/thechriswalker/protoc-gen-twirp_js | |
| JavaScript | ✓ | github.com/Xe/twirp-codegens/cmd/protoc-gen-twirp_jsbrowser | |
| JavaScript | ✓ | ✓ | github.com/tatethurston/TwirpScript |
| Typescript | ✓ | ✓ | github.com/hopin-team/twirp-ts |
| Typescript | ✓ | github.com/larrymyers/protoc-gen-twirp_typescript | |
| Typescript | ✓ | ✓ | github.com/tatethurston/TwirpScript |
| Typescript | ✓ | ✓ | github.com/timostamm/protobuf-ts |
| Ruby | ✓ | ✓ | github.com/twitchtv/twirp-ruby |
| Rust | ✓ | ✓ | github.com/cretz/prost-twirp |
| Scala | ✓ | ✓ | github.com/soundcloud/twinagle |
| Swagger | ✓ | ✓ | github.com/go-bridget/twirp-swagger-gen |
| PHP | ✓ | ✓ | github.com/twirphp/twirp |
| Dart | ✓ | github.com/apptreesoftware/protoc-gen-twirp_dart | |
| Elixir | ✓ | ✓ | github.com/keathley/twirp-elixir |
| Swift | ✓ | github.com/CrazyHulk/protoc-gen-swiftwirp | |
| Crystal | ✓ | ✓ | github.com/mloughran/twirp.cr |
Support and Community
We have a channel on the Gophers slack, #twirp, which is the best place to get quick answers to your questions. You can join the Gopher slack here.
Releases
Twirp follows semantic versioning through git tags, and uses Github Releases for release notes and upgrade guides: Twirp Releases
Contributing
Check out CONTRIBUTING.md for notes on making contributions.
License
This library is licensed under the Apache 2.0 License.