新公司业务接口传输用的是google的protobuf,今儿简单学习了一下,流程整明白了。写给记性不好的自己,也写给翻到这里的朋友。
系统环境:windows(mac的更简单,咱就喜欢用win)
根据proto整一个有逼格的接口文档
需要准备
- protobuf编译工具protoc windows最新版直达飞机 其他版本
- protobuf文档生成器protoc-gen-doc 自己clone
正文
- 解压上面protoc得到一个protoc.exe, 找个bin目录放进去,记得把bin目录加入环境变量
- 上面protoc-gen-doc解压后得到一个go项目代码,进入protoc-gen-doc/cmd/protoc-gen-doc,然后go build一下得到一个protoc-gen-doc.exe, 和第一步一样,放到那个bin目录
- 下面开始生成文档,先找个目录取名叫:myproto, 里面放入你的proto文件,在建个和myproto同级的目录mydoc,然后拷下面命令:
protoc.exe --plugin=protoc-gen-doc=/usr/bin/protoc-gen-doc.exe --doc_out=./mydoc --doc_opt=html,fuck3.html myproto/*.proto
执行完毕,不出意外,mydoc目录里面有个fuck3.html的文件,这就是你的接口文档了。
从proto生成一个pb.go文件
protoc --go_out=. my/errcode.proto
很简单,看代码就懂了
网友评论