grpc-gateway icon indicating copy to clipboard operation
grpc-gateway copied to clipboard

The code in the README.md file does not work

Open jayeye opened this issue 1 year ago • 4 comments

📚 Documentation

THe sample go code in https://github.com/grpc-ecosystem/grpc-gateway#usage section 5 does not create a running grpc server.

jayeye avatar Nov 23 '22 05:11 jayeye

Hi! Sorry for the confusion, that's not meant to be a gRPC server, it's a very basic gRPC-Gateway that dials an existing gRPC server. It's small because it needs to fit into the README. What problem exactly did you have with it? Maybe you should try our step by step tutorial instead?

johanbrandhorst avatar Nov 23 '22 06:11 johanbrandhorst

Thanks. That one sentence (that it requires a separate grpc server) would have saved me a lot of time if it were present in the readme. Now that I look at it again, it's obvious, but it wasn't before :) Add it, please?

jayeye avatar Nov 23 '22 15:11 jayeye

Yeah great point we definitely should have a link to the step by step tutorial. Would you be willing to contribute a fix to the README?

johanbrandhorst avatar Nov 23 '22 16:11 johanbrandhorst

I suppose I could :)

jayeye avatar Nov 26 '22 18:11 jayeye