Rename & Add OpenAPI Specification Generator (#107)

* rename npm name to wechaty-grpc (#106)

* add grpc http annotations (wip)

* add grpc gateway image

* add swagger info annotation

* make payload dirty restful

* fix name

* add more restful endpoint definitions

* fix streaming methods

* better protoc tools installer script

* clean openapi scripts

* rename src/index -> src/mod

* generate proto js files with annotation

* 0.19.1

Author: huan

.github/workflows/node.js.yml

@@ -38,7 +38,7 @@ jobs:
     - name: Install Dependencies
       run: |
         npm install
-        npm run install:lint:protoc
+        npm run install:protoc
 
     - name: Generate gRPC Stubs
       run: npm run generate

.github/workflows/npm.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Install Dependencies
         run: |
           npm install
-          npm run install:lint:protoc
+          npm run install:protoc
 
       - name: Generate gRPC Stubs
         run: npm run generate

.gitignore

@@ -94,3 +94,4 @@ csharp/Wechaty.Grpc/bin/
 csharp/Wechaty.Grpc/nupkg/package/
 csharp/Wechaty.Grpc/Properties
 
+third-party/

README.md

@@ -149,6 +149,12 @@ protoc \
 
 > <https://github.com/improbable-eng/ts-protoc-gen>
 
+## OpenAPI
+
+![gRPC Gateway](docs/images/grpc-gateway-architecture.svg)
+
+> Image credit: [grpc-gateway](https://grpc-ecosystem.github.io/grpc-gateway/)
+
 ## RESOURCES
 
 ### Documentation

docs/images/grpc-gateway-architecture.svg

@@ -13,7 +13,7 @@ import {
   EventResponse,
   ContactAliasRequest,
   // EventType,
-}                     from '../src/'
+}                     from '../src/mod'
 import { StringValue } from 'google-protobuf/google/protobuf/wrappers_pb'
 
 /**

examples/client.ts

@@ -9,7 +9,7 @@ import {
   EventType,
   DingResponse,
   EventRequest,
-}                       from '../src/index'
+}                       from '../src/mod'
 
 // import { StringValue } from 'google-protobuf/google/protobuf/wrappers_pb'
 

examples/server.ts

@@ -1,3 +1,2 @@
-gen/
 gateway
 go.sum

openapi/.gitignore

@@ -1,46 +1,45 @@
-PROTOC=protoc \
+GENERATED_DIR:="${CURDIR}/../generated/"
+THIRD_PARTY_DIR:="${CURDIR}/../third-party/"
+
+PROTOC:=protoc \
 	-I ../proto/ \
 	-I ../proto/wechaty/ \
+	-I ${THIRD_PARTY_DIR} \
 	../proto/wechaty/puppet.proto \
 
 .PHONY: all
-all: clean generate reverse_proxy_server
+all: generate
+
+.PHONY: generate
+generate:
+	${PROTOC} \
+		--openapiv2_out ${GENERATED_DIR} \
+		--openapiv2_opt logtostderr=true \
+		--openapiv2_opt generate_unbound_methods=true \
 
 .PHONY: clean
 clean:
-	rm -fr gen/*
+	rm -fr ${GENERATED_DIR}/*
 
 .PHONY: install
 install:
-	[ -d gen ] || mkdir gen
 	go install \
 		github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway \
 		github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2 \
 		google.golang.org/protobuf/cmd/protoc-gen-go \
 		google.golang.org/grpc/cmd/protoc-gen-go-grpc
 	go mod tidy
 
-.PHONY: generate
-generate: gen_protobuf gen_gateway gen_openapi
-
 .PHONY: gen_protobuf
 gen_protobuf:
 	${PROTOC} \
-		--go_out ./gen/ --go_opt paths=source_relative \
-		--go-grpc_out ./gen/ --go-grpc_opt paths=source_relative \
-		../proto/wechaty/puppet.proto
+		--go_out ${GENERATED_DIR} --go_opt paths=source_relative \
+		--go-grpc_out ${GENERATED_DIR} --go-grpc_opt paths=source_relative \
 
 .PHONY: gen_gateway
 gen_gateway:
 	${PROTOC} \
-		--grpc-gateway_out ./gen/ \
+		--grpc-gateway_out ${GENERATED_DIR} \
 		--grpc-gateway_opt logtostderr=true \
 		--grpc-gateway_opt paths=source_relative \
 		--grpc-gateway_opt generate_unbound_methods=true \
-
-.PHONY: gen_openapi
-gen_openapi:
-	${PROTOC} \
-		--openapiv2_out ./gen/ \
-		--openapiv2_opt logtostderr=true \
-

openapi/Makefile

@@ -1,2 +1,4 @@
+# GO gRPC Gateway
 
-gRPC Gateway: <https://github.com/grpc-ecosystem/grpc-gateway>
+- gRPC Gateway: <https://github.com/grpc-ecosystem/grpc-gateway>
+- Template: <https://github.com/johanbrandhorst/grpc-gateway-boilerplate>