Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

gRPC documentation generator

Does gRPC support generating documentation for services like Swagger?

like image 871
Max Ng Avatar asked Aug 04 '15 21:08

Max Ng


2 Answers

Your protofiles are the documentation. You can put comments there to clarify meaning of parameters or service methods.

like image 75
Timmy Avatar answered Sep 18 '22 15:09

Timmy


protoc-gen-doc is a protoc plugin which generates HTML docs using Go HTML templates. Although it isn't being used by the original sponsor company anymore, it looks like a good starting point.

like image 45
Eric Drechsel Avatar answered Sep 17 '22 15:09

Eric Drechsel