[](https://github.com/wechaty/grpc/actions/workflows/node.yml)
[](https://github.com/wechaty/grpc/actions/workflows/csharp.yml)
[](https://github.com/wechaty/grpc/actions/workflows/go.yml)
[](https://github.com/wechaty/grpc/actions/workflows/java.yml)
[](https://github.com/wechaty/grpc/actions/workflows/php.yml)
[](https://github.com/wechaty/grpc/actions/workflows/python.yml)
[](https://www.npmjs.com/package/wechaty-grpc)
[](https://pypi.org/project/chatie-grpc/)
[](https://mvnrepository.com/artifact/io.github.wechaty/grpc)
[](https://packagist.org/packages/wechaty/php-grpc)
[](https://nodejs.org/)
[](https://www.python.org/downloads/release/python-370/)
[](https://pkg.go.dev/github.com/wechaty/grpc/go/wechaty)
Table of Contents
-
About
-
Usage
-
Development
- OpenAPI
- gRPC Web
- Resources
- Contributing
- Maintainer
- Copyright & License
## About
gRPC is a modern open-source high-performance Remote Procedure Call (RPC) framework that can run in any environment. It can efficiently connect services in and across data centers with pluggable support for load balancing, tracing, health checking, and authentication. It is also applicable in the last mile of distributed computing to connect devices, mobile applications, and browsers to backend services.
## Usage
### Node.js
[wechaty-grpc@NPM](https://www.npmjs.com/package/wechaty-grpc)
**Docs:**
-
-
**Maintainer:**
- [@huan](https://github.com/huan) - Huan LI (李卓桓)
### Python
[chatie-grpc@PyPI](https://pypi.org/project/chatie-grpc)
**Maintainer:**
- [@wj-Mcat](https://github.com/wj-Mcat) - Jingjing WU (吴京京)
### Go
[github.com/wechaty/go-grpc](https://github.com/wechaty/go-grpc)
**Maintainer:**
- [@dchaofei](https://github.com/dchaofei) - Chaofei DING (丁超飞)
### Java
[https://mvnrepository.com/artifact/io.github.wechaty/grpc](https://mvnrepository.com/artifact/io.github.wechaty/grpc)
**Maven:**
```xml
io.github.wechaty
0.11.25
grpc
```
**Gradle:**
```groovy
compile 'io.github.wechaty:grpc:0.11.25'
```
**Maintainer:**
- [@diaozxin007](https://github.com/diaozxin007) - Zhengxin DIAO (刁政欣)
### PHP
[github.com/wechaty/php-grpc](https://github.com/wechaty/php-grpc)
**Maintainer:**
- [@zhangchunsheng](https://github.com/zhangchunsheng) - Chunsheng ZHANG (张春生)
### CSharp
[Wechaty.Grpc @ Nuget](https://www.nuget.org/packages/Wechaty.Grpc)
**Maintainer:**
- [@Darren](https://github.com/jesn) - Darren (郑波)
## Development
### Debug
- [GUI Client for GRPC Services](https://github.com/uw-labs/bloomrpc) - BloomRPC aims to give the simplest and efficient developer experience for exploring and querying your GRPC services. (Inspired by Postman and GraphQL Playground)
- [A gRPC CLI interface for easy testing against gRPC servers with Node.js REPL](https://github.com/njpatel/grpcc)
```shell
grpcc --proto ./service/myservice.proto --address 127.0.0.1:3466
```
### Build
```shell
./scripts/install-protoc.sh
npm install
```
>
### Generate Stubs
```shell
npm run generate
```
#### 1. JS for Protocol Buffer
```shell
protoc \
--js_out="import_style=commonjs,binary:${OUT_DIR}"
```
>
#### 2. JS for gRPC Stubs
```shell
protoc \
--plugin="protoc-gen-grpc=`which grpc_tools_node_protoc_plugin`" \
--grpc_out="${OUT_DIR}"
```
>
#### 3. TypeScript Typing Definations for Protocol Buffer & gRPC Stubs
```shell
protoc \
--plugin="protoc-gen-grpc=node_modules/grpc_tools_node_protoc_ts/bin/protoc-gen-ts" \
--grpc_out="${OUT_DIR}"
```
>
#### 4. JS & TS for gRPC Web
```shell
protoc \
--plugin="protoc-gen-ts=node_modules/ts-protoc-gen/bin/protoc-gen-ts" \
--ts_out="service=true:${OUT_DIR}"
```
>
### Naming conventions & Style Guide
1. [Google Cloud APIs - Naming conventions](https://cloud.google.com/apis/design/naming_convention)
1. [Protocol Buffers - Developer Guide - Style Guide](https://developers.google.com/protocol-buffers/docs/style)
## OpenAPI
Learn more about the RESTful API service for Wechaty from [Wechaty OpenAPI](https://github.com/wechaty/openapi).
## gRPC Web
- [gRPC-Web ReactJS client, Golang Server](https://github.com/longfellowone/grpcwebtest)
## RESOURCES
### Documentation
- [Protocol Buffers Language Guide (proto3)](https://developers.google.com/protocol-buffers/docs/proto3)
- [Google Protocol Buffers Style Guide](https://developers.google.com/protocol-buffers/docs/style)
- [Protocol Buffers for TypeScript with Decorators](https://github.com/protobufjs/protobuf.js#using-decorators)
- [Troubleshooting gRPC](https://github.com/grpc/grpc/blob/master/TROUBLESHOOTING.md)
- [gRPC environment variables](https://github.com/grpc/grpc/blob/master/doc/environment_variables.md)
- [How to Interact With and Debug a gRPC Server](https://medium.com/@EdgePress/how-to-interact-with-and-debug-a-grpc-server-c4bc30ddeb0b)
### Links
- [探讨gRPC的Node技术生态及实现工具](https://xenojoshua.com/2018/02/grpc-node-ecosystem/)
- [gRPC Basics - Node.js](https://grpc.io/docs/tutorials/basic/node.html)
- [Building a gRPC service with Node.js](https://codelabs.developers.google.com/codelabs/cloud-grpc/)
- [gRPC in 3 minutes (Node.js)](https://github.com/grpc/grpc/tree/master/examples/node)
- [Listen gRPC and HTTP requests on the same port](https://medium.com/@drgarcia1986/listen-grpc-and-http-requests-on-the-same-port-263c40cb45ff)
- [gRPC to JSON proxy generator following the gRPC HTTP spec](https://github.com/grpc-ecosystem/grpc-gateway)
- [如何在 Node.js 中更优雅地使用 gRPC：grpc-helper](https://github.com/xizhibei/blog/issues/86)
- [Comparing OpenAPI With gRPC](https://dzone.com/articles/comparing-openapi-with-grpc)
#### Protocol Buffer
Thanks to the ecosystem of gRPC, we can generate OpenAPI Specification from our gRPC proto definitions automatically.
We are using [gRPC to JSON proxy generator following the gRPC HTTP spec](https://github.com/grpc-ecosystem/grpc-gateway) as the OpenAPI Specification generator ([protoc-gen-openapiv2](https://github.com/grpc-ecosystem/grpc-gateway/tree/master/protoc-gen-openapiv2)), and using [Like grpc-gateway, but written in node and dynamic](https://github.com/konsumer/grpc-dynamic-gateway) project to serve an HTTP RESTful API to gRPC proxy.
Made with [contrib.rocks](https://contrib.rocks).
## Maintainer
Wechaty is maintained by [Huan](https://github.com/huan), [Rui](https://github.com/lijiarui), and a community of Open Source Contributors. We are always looking for people to join the Wechaty community to maintain the Wechaty codebase and documentation. You necessarily don't have to be a programmer to contribute to Wechaty. To get started contributing, you can read the [CONTRIBUTING.md](http://github.com/wechaty/grpc/blob/master/CONTRIBUTING.md).
## Getting help
Wechaty has a community of very helpful contributors on different platforms you can join to get help from. Before joining any of the communities, we recommend that you read our Code of conduct]o that you adhere to our community guidelines. A full list of the different Wechaty communities can be accessed from the [Wechaty community](https://wechaty.js.org/docs/community/) section of this documentation.
## Copyright & License
Wechaty is an [Open Source Project](https://opensource.com/resources/what-open-source). It is released under [Apache-2.0 license](https://github.com/wechaty/wechaty/blob/master/LICENSE) and the corresponding documentation is released under the [Creative Commons license](https://creativecommons.org/licenses/).
