voytechnology / protoc-gen-rest

Create easy to consume REST APIs from protobufs

VoyTechnology

Repository with my personal site

protoc-gen-rest's Issues

Handle Content-Type: application/json

Accept Content-Type: application/json and return the result. This should be the default as its a widely used standard.

Path Match on GET Request

Because we do not support input data, we would want to match parts of the request path and match it to the request.

eg.

rpc Multiply(Request) returns (Response) {
  option (google.api.http) = {
    get: "/multiply/{a}/{b}"
  };
}

message Request {
  int a = 1;
  int b = 2;
}

GET /multiply/2/3
6

func (s *Server) Multiply(ctx context.Context, req *pb.Request) (*pb.Response, error) {
  fmt.Println(req) // { A: 2, B: 3 }
  return &pb.Response{Result: req.A * req.B}, nil
}

Generate Client Code

Generate the client side code so that you can use http.Client to make requests.

Handle Content-Type: application/grpc-web+proto

We should be able to decode the raw proto data returned.

Compatibility with connect-go

While we cannot implement compatibility with every other protoc generator, connect-go looks like it might be a good fit

https://connect.build

This would be possibly done with a opt

library_compat=connect-go

With default being ""

Conditionally create service interface

The service interface should only be created conditionally - if the server already has gRPC generated, we should not generate it again.
Perhaps this can be done with a generator option:

service_interface: false

Compatibility with gRPC

Make the generated code compatible with gRPC by using library_compat=grpc option.

Generate Server Code

Generate server side code. This should return a http.Handler which will listen to the incoming HTTP requests and use the provided server interface to call the service methods.

Do not parse input on GET requests

If we get a GET request, we should not be attempting to parse the input variable.