新公司業(yè)務(wù)接口傳輸用的是google的protobuf,今兒簡單學(xué)習(xí)了一下淡溯,流程整明白了纲堵。寫給記性不好的自己雷猪,也寫給翻到這里的朋友票从。
系統(tǒng)環(huán)境:windows(mac的更簡單,咱就喜歡用win)
根據(jù)proto整一個(gè)有逼格的接口文檔
需要準(zhǔn)備
- protobuf編譯工具protoc windows最新版直達(dá)飛機(jī) 其他版本
- protobuf文檔生成器protoc-gen-doc 自己clone
正文
- 解壓上面protoc得到一個(gè)protoc.exe罩抗, 找個(gè)bin目錄放進(jìn)去拉庵,記得把bin目錄加入環(huán)境變量
- 上面protoc-gen-doc解壓后得到一個(gè)go項(xiàng)目代碼,進(jìn)入protoc-gen-doc/cmd/protoc-gen-doc套蒂,然后go build一下得到一個(gè)protoc-gen-doc.exe, 和第一步一樣钞支,放到那個(gè)bin目錄
- 下面開始生成文檔茫蛹,先找個(gè)目錄取名叫:myproto, 里面放入你的proto文件,在建個(gè)和myproto同級的目錄mydoc,然后拷下面命令:
protoc.exe --plugin=protoc-gen-doc=/usr/bin/protoc-gen-doc.exe --doc_out=./mydoc --doc_opt=html,fuck3.html myproto/*.proto
執(zhí)行完畢,不出意外烁挟,mydoc目錄里面有個(gè)fuck3.html的文件婴洼,這就是你的接口文檔了。
從proto生成一個(gè)pb.go文件
protoc --go_out=. my/errcode.proto
很簡單信夫,看代碼就懂了