通過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

     


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM