gRPCのインターフェースドキュメント自動生成に苦しんだので記事化

今回の容疑者

protoc --doc_out=. --doc_opt=html,index.html file.proto

上記コマンドで自動生成出来るはずだった。

しかし、出来なかった。

error内容


protoc-gen-doc: program not found or is not executable
Please specify a program using absolute path or make sure the program is available in your PATH system variable      
--doc_out: protoc-gen-doc: Plugin failed with status code 1.

現場に居るパッケージは以下の通り。

go.mod

github.com/pseudomuto/protoc-gen-doc v1.5.1

こちらのコマンドは実行済だ。


go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc

# 実行結果
# module github.com/golang/protobuf is deprecated: Use the "google.golang.org/protobuf" module instead.

わけがわからない。

ひたすら記事を探し(公式とか海外のは出来るだけ避けた(あかん))...

gRPC開発におけるドキュメントを自動生成する(Zenn)
- https://zenn.dev/jy8752/articles/2e77da36cae0c3

# 実行
go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest

#go: downloading github.com/envoyproxy/protoc-gen-validate v0.3.0-java
#go: downloading google.golang.org/genproto v0.0.0-20210917145530-b395a37504d4
#go: downloading google.golang.org/protobuf v1.27.1
#go: downloading github.com/google/uuid v1.1.2
#go: downloading golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9

# 実行
protoc -I. --doc_out=. --doc_opt=html,index.html *.proto

( ﾟдﾟ)ﾊｯ!ﾃﾞｹﾀ!!!

ありがとう、どこかの(Zenn)ぱんださん

Conclusion

1時間失いました。