jmzwcn / api-gateway

A gateway to automatically provide RESTful API for gRPC

API Gateway

A native and easy gateway to provide RESTful API for gRPC, inspired by grpc-gateway, but fully automatic, also support bi-directional streaming(websocket).

Prepare:

• Download&&Install golang/protoc/docker and Env setting.

Usage:

• Get code: [git clone https://github.com/jmzwcn/api-gateway.git];
• Generate your *.pb.go with protoc-gen-gogogo;
• Run "make" in Makefile;
• Try the URL in your proto.

How to define RESTful in *.proto: [custom option]

your_service.proto:

 syntax = "proto3";
 package example;
+
+import "google/api/annotations.proto";
+
 message StringMessage {
   string value = 1;
 }
 
 service YourService {
-  rpc Echo(StringMessage) returns (StringMessage) {}
+  rpc Echo(StringMessage) returns (StringMessage) {
+    option (google.api.http) = {
+      post: "/v1/example/echo"
+      body: "*"
+    };
+  }
 }

Enjoy it!

---