github.com/twitchtv/twirp
Copyright 2018 Twitch Interactive, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Package twirp provides core types used in generated Twirp servers and client. Twirp services handle errors using the `twirp.Error` interface. For example, a server method may return an InvalidArgumentError: And the same twirp.Error is returned by the client, for example: Clients may also return Internal errors if something failed on the system: the server, the network, or the client itself (i.e. failure parsing response). Copyright 2018 Twitch Interactive, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Copyright 2018 Twitch Interactive, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Readme
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!
Read more about the motivation behind on the announcement blog post.
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 |
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.
Twirp follows semantic versioning through git tags, and uses Github Releases for release notes and upgrade guides: Twirp Releases
Check out CONTRIBUTING.md for notes on making contributions.
This library is licensed under the Apache 2.0 License.
FAQs
Copyright 2018 Twitch Interactive, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Package twirp provides core types used in generated Twirp servers and client. Twirp services handle errors using the `twirp.Error` interface. For example, a server method may return an InvalidArgumentError: And the same twirp.Error is returned by the client, for example: Clients may also return Internal errors if something failed on the system: the server, the network, or the client itself (i.e. failure parsing response). Copyright 2018 Twitch Interactive, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Copyright 2018 Twitch Interactive, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A hospital in Mobile, Alabama, agreed to a settlement in a landmark ransomware death lawsuit, but is now reportedly reconsidering the agreement and refusing to pay.
Security News
A new report explores how advancements in LLMs are enhancing cyber threats, including polymorphic malware, personalized spearphishing, and the risk of hijacking customer service bots.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.
