Wechaty-grpc NPM

Wechaty GRPC

Wechaty gRPC

Go Version

gRPC for Wechaty Puppet Service

USAGE

Node.js

wechaty-grpc@NPM

Maintainer:

@huan - Huan LI (李卓桓)

Python

chatie-grpc@PyPI

Maintainer:

@wj-Mcat - Jingjing WU (吴京京)

Go

github.com/wechaty/go-grpc

Maintainer:

@dchaofei - Chaofei DING (丁超飞)

Java

https://mvnrepository.com/artifact/io.github.wechaty/grpc

Maven:

<dependency>
    <groupId>io.github.wechaty</groupId>
    <version>0.11.25</version>
    <artifactId>grpc</artifactId>
</dependency>

Gradle:

compile 'io.github.wechaty:grpc:0.11.25'

Maintainer:

@diaozxin007 - Zhengxin DIAO (刁政欣)

PHP

github.com/wechaty/php-grpc

Maintainer:

@zhangchunsheng - Chunsheng ZHANG (张春生)

Csharp

Wechaty.Grpc @ Nuget

Maintainer:

@Darren - Darren (郑波)

DEVELOPMENT

Debug

GUI Client for GRPC Services - BloomRPC aim 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
```
grpcc --proto ./service/myservice.proto --address 127.0.0.1:3466
```

Build

./scripts/install-protoc.sh
npm install

https://github.com/google/protobuf/releases/latest

Generate Stubs

npm run generate

1. JS for Protocol Buffer

protoc \
  --js_out="import_style=commonjs,binary:${OUT_DIR}"

https://github.com/google/protobuf/releases/latest

2. JS for gRPC Stubs

protoc \
  --plugin="protoc-gen-grpc=`which grpc_tools_node_protoc_plugin`" \
  --grpc_out="${OUT_DIR}"

https://www.npmjs.com/package/grpc-tools

3. TypeScript Typing Definations for Protocol Buffer & gRPC Stubs

protoc \
  --plugin="protoc-gen-grpc=node_modules/grpc_tools_node_protoc_ts/bin/protoc-gen-ts" \
  --grpc_out="${OUT_DIR}"

https://github.com/agreatfool/grpc_tools_node_protoc_ts

4. JS & TS for gRPC Web

protoc \
  --plugin="protoc-gen-ts=node_modules/ts-protoc-gen/bin/protoc-gen-ts" \
  --ts_out="service=true:${OUT_DIR}"

https://github.com/improbable-eng/ts-protoc-gen

OpenAPI

Thanks for 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 as the OpenAPI Specification generator (protoc-gen-openapiv2), and using Like grpc-gateway, but written in node and dynamic project to serve a HTTP RESTful API to gRPC proxy.

Image credit: grpc-gateway

Learn more about the RESTful API service for Wechaty from Wechaty OpenAPI.

gRPC Web

gRPC-Web ReactJS client, Golang Server

RESOURCES

Documentation

HISTORY

master

v0.20 (Feb 21, 2021)

Rename NPM module name from @chatie/grpc to wechaty-grpc
Add OpenAPI annotations & generators for supporting https://github.com/wechaty/openapi
Code clean.

v0.18 (Oct 15, 2020)

Add new MessageFileStream and MessageImageStream to replace the MessageFile and MessageImage method to avoid blocking nodejs event loop when sending large files (#88) by @windmemory
Add new MessageSendFileStream to replace the MessageSendFile method to avoid blocking nodejs event loop when sending large files (#89) by @windmemory