twirk 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.
Define your service in a
Protobuf file and
then twirk autogenerates Go code with a server interface and fully functional
clients. It's 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 clients for easy integrations across
languages
twirk handles routing and serialization for you in a well-tested, standardized, thoughtful way so you don't have to. Serialization and deserialization code is error-prone and tricky, and you shouldn't be wasting your time deciding whether it should be "POST /friends/:id/new" or "POST /:id/friend" or whatever. Just get to the real work of building services!
Along the way, you get an autogenerated client and a simple, smart framework for passing error messages. Nice!
For more on the motivation behind twirk (and a comparison to REST APIs and gRPC), the announcement blog post is a good read.
Use go get to install the Go client-and-server generator:
go get github.com/darioielardi/twirk/protoc-gen-twirk
You will also need:
- protoc, the protobuf compiler. You need version 3+.
- github.com/golang/protobuf/protoc-gen-go,
the Go protobuf generator plugin. Get this with
go get.
Thorough documentation is on the website.
Source for this documentation is in the docs subdirectory. The website is generated from that folder using Docusaurus.
This repo only has the official generators, which write out Go and Python code. For other languages, there are third-party generators available:
| Language | Clients | Servers | Repository |
|---|---|---|---|
| Java | ✓ | ✓ | github.com/fajran/protoc-gen-twirk_java_jaxrs |
| Java | ✓ | https://github.com/devork/flit | |
| JavaScript | ✓ | github.com/thechriswalker/protoc-gen-twirk_js | |
| JavaScript | ✓ | github.com/Xe/twirk-codegens/cmd/protoc-gen-twirk_jsbrowser | |
| Typescript | ✓ | github.com/larrymyers/protoc-gen-twirk_typescript | |
| Ruby | ✓ | ✓ | github.com/darioielardi/twirk-ruby |
| Rust | ✓ | ✓ | github.com/cretz/prost-twirk |
| Swagger | ✓ | ✓ | github.com/elliots/protoc-gen-twirk_swagger |
| PHP | ✓ | ✓ | github.com/twirkhp/twirk |
| Dart | ✓ | github.com/apptreesoftware/protoc-gen-twirk_dart |
This list isn't an endorsement, it's just a convenience to help you find stuff for your language.
We have a channel on the Gophers slack, #twirk, which is the best place to get quick answers to your questions. You can join the Gopher slack here.
twirk follows semantic versioning through git tags, and uses Github Releases for release notes and upgrade guides: twirk Releases
Check out CONTRIBUTING.md for notes on making contributions.
This library is licensed under the Apache 2.0 License.