通过protoc-gen-doc生成 pb 文档

  • 首先安装protoc-gen-doc
     go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc

     

  • 将当前项目的文件copy到制定目录
     #在项目目录 copy proto 文件到c盘proto
       Copy-Item .\*\*.proto C:\proto -Recurse

     

  • 通过命令构建文档
    #支持生成 html markdown json 等 使用该命令前提必须当前目录下有doc 文件夹 
    protoc --doc_out=./doc --doc_opt=html,index.html *.proto
    #生成markdown
    protoc --doc_out=./doc --doc_opt=markdown,index.md *.proto

    这里可能会报import引用问题, 有两个解决方案 一个是把缺少的引用文件放到c盘的proto文件 ,一个是通过 -I 参数添加import

  • 生成swagger 
     go get "github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2"
    
     protoc --openapiv2_out .  --openapiv2_opt allow_merge=true,merge_file_name=dms --openapiv2_opt logtostderr=true ./*.proto
    
     swagger serve -F=swagger ./dms.swagger.json --host=localhost -p=5000

     

posted @ 2021-03-26 16:29  雨V幕  阅读(1424)  评论(0编辑  收藏  举报