因为在生成 gRPC 接口文档方面遇到了困难,所以决定将它写成一篇文章

因为遇到了gRPC接口文档的自动生成问题,所以将其记录成了一篇文章。

这次的嫌疑人

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

应该可以通过上述命令自动生成。

 


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.

 

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

哇!吓到我了!太可怕了!

image.png

结论

    1時間失いました。
广告
将在 10 秒后关闭
bannerAds