谷歌插件protoc-gen-doc实现 proto转文档详细解坑

最新推荐文章于 2024-05-18 13:27:01 发布
最新推荐文章于 2024-05-18 13:27:01 发布
阅读量2.5k 收藏
点赞数
文章标签： protobuf proto插件 protoc-gen-doc protoc  go
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_44612322/article/details/102949871
版权
本文详述如何使用谷歌插件protoc-gen-doc将proto协议转换为文档，便于开发人员和非开发人员之间的沟通。内容包括protoc-gen-doc的安装步骤，解决go get获取依赖包失败的问题，以及在安装过程中遇到的内存不足问题的解决办法。
摘要由CSDN通过智能技术生成

谷歌插件protoc-gen-doc实现 proto转文档详细解坑

背景

出于工作需求要求自己开发接口协议。为了尽快熟悉proto协议使用谷歌插件proto-gen-doc将proto转文档查看。（不得不说，确实方便，大大便捷了开发人员和非开发之间交流）

安装步骤

环境

protoc3.11.0 golang go1.12.10 ubuntu16

protobuf安装

https://github.com/google/protobuf

chmod 777 -R protobuf
cd protobuf
./autogen
./configure
make
make install
ldconfig

顺利完成（如果不幸make途中任何地方出现问题，一定要make clean清除干净之后重新进行）

protoc --version查看版本

protoc-gen-doc插件安装

https://github.com/pseudomuto/protoc-gen-doc

go get 获取项目安装

go get github.com/pseudomuto/proto-gen-doc/cmd/protoc-gen-doc

默认自动gopath下自动生成 protoc-gen-doc可执行文件免去编译过程

将可执行文件复制到path bin
protoc --plugin=protoc-gen-doc=./proto-gen-doc --doc_o

最低0.47元/天 解锁文章
奋斗的Jay麦霸
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 6
    评论
protoc-gen-validate:protoc插件生成多语种消息验证器
05-11
PGV是一个协议插件，用于生成多语种消息验证器。 尽管协议缓冲区有效地保证了结构化数据的类型，但它们不能对值强制执行语义规则。 该插件为协议生成的代码添加了支持，以验证此类约束。 开发人员导入PGV扩展名，并...
protoc-gen-doc:Google协议缓冲区的文档生成器插件
04-12
原始文件 这是Google协议缓冲区编译器（ protoc ）的文档生成器插件。 该插件可以从.proto文件中的注释生成HTML，JSON，DocBook和Markdown文档。 它支持proto2和proto3，并且可以在相同的上下文中处理这两个问题（有关，请参见）。 安装 有一个可用的Docker映像（ docker pull pseudomuto/protoc-gen-doc ），其中包含从protos生成文档所需的一切。 如果您想在本地安装它，则go get它。 go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc 调用插件 通过将--doc_out和--doc_opt选项传递给protoc编译器来调用该插件。 该选项具有以下格式： --doc_opt=<FORMAT>|<TEMPLATE_
protoc-gen-doc：优雅地为Protocol Buffers生成文档
gitblog_00051的博客
05-12 415
protoc-gen-doc：优雅地为Protocol Buffers生成文档 项目地址:https://gitcode.com/pseudomuto/protoc-gen-doc 项目介绍 protoc-gen-doc 是一个针对 Google Protocol Buffers（简称 Protobuf）编译器的插件，用于从你的 .proto 文件中的注释生成 HTML、JSON、DocBook ...
protoc-gen-go-grpc: program not found or is not executable 解决方法
最新发布
05-18 365
这个的原因就是你当前的GOPATH/bin目录下面没有对应的可执行文件 protoc-gen-go-grpc ，执行以下命令安装即可：go get google.golang.org/grpc/cmd/protoc-gen-go-grpc
Go - 使用工具生成易读的 Protocol 文档
新亮笔记
01-20 380
文章目录：前言protoc-gen-doc安装使用演示小结推荐阅读前言通过 .proto 文件能否生成更易阅读 HTML 文档？关于这个问题，我找到了一个插件，给大家分享一下。protoc...
protoc-gen-doc, Google协议缓冲区的文档生成器插件.zip
09-18
protoc-gen-doc, Google协议缓冲区的文档生成器插件 protoc-gen-doc 这是一个用于Google协议缓冲区编译器( protoc )的文档生成器插件。 插件可以从 .proto 文件中的注释生成 HTML 。JSON 。DocBook和 Markdown 文档。它支持pr
grpc protobuf接口文档生成插件
今天星期六
12-29 752
个人独立开发grpc protobuf api文档生成插件，开源项目，欢迎各位大佬试用，积极接纳优化建议，喜欢的大佬来个☆☆☆。
protoc-gen-go与protoc-gen-go-grpc插件
06-10
标题中的"protoc-gen-go与protoc-gen-go-grpc插件"是指Google开源的Protocol Buffers（protobuf）生态系统中的两个关键工具，它们是为Go语言设计的编译器插件。Protocol Buffers是一种序列化协议，它允许数据以高效...
protoc-gen-gotag:将自定义结构标签添加到protobuf生成的结构
05-10
PGGT是一个protoc插件，用于在生成的protobuf消息上添加/替换struct标签。 使用go get github.com/srikrsna/protoc-gen-gotag获取它go get github....
ts-protoc-gen：用于TypeScript和gRPC-Web的协议缓冲区编译器（protoc）插件
02-06
ts-protocgen Protoc插件，用于生成TypeScript声明该存储库包含一个插件，该插件生成与protoc --js_out=import_style=commonjs,binaryJavaScript输出匹配的TypeScript声明（ .d.ts文件）。 该插件还可以将服务定义...
protoc-gen-markdown:协议插件
04-11
protoc-gen-markdown 根据proto文件生成markdown文档 依赖protoc，请先安装protoc3 安装 go get -u github.com/x-lambda/protoc-gen-markdown 使用 protoc -I . --markdown_out=prefix=/api,package=demo.v0,filename=foo.md:. demo.proto TODO 补充test case，手动创建一个CodeGeneratorRequest对象，然后使用proto.Marshal()序列化成字节对象， 最后通过buffer包装成io.Reader，验证输出结果是否和预期一致。 参考 CodeGeneratorRequest对象比较复杂，可以参考已有的文档/项目来理解 github.com/davyxu/pbmeta 项目将protoc传递的C
05-DOC、PPT文档转换为Flash格式或PDF-FlashPaper
11-01
05-DOC、PPT文档转换为Flash格式或PDF-FlashPaper
protobuf-2.4.1与protoc-gen-lua压缩文件
03-23
具体操作，可根据我的个人博文进行。.proto文件生成_Pb.lua文件使用工具。
prototools:protobufgRPC的文档生成器和其他工具
05-17
原型工具 该存储库包含各种Protobuf / gRPC工具： protoc-gen-doc是Protobuf编译器插件，用于使用标准Go HTML模板文件从.proto文件生成HTML文档。 protoc-gen-json是一个Protobuf编译器插件，用于为protoc插件生成请求生成JSON转储文件。 它主要用于运行测试而无需直接调用protoc （例如，通过Go测试套件）。 protoc-gen-dump类似于protoc-gen-json不同之处在于它本身以protobuf格式转储输出。 如果可以使用它，它比protoc-gen-json好得多，因为其中某些字段（例如 ）被明确标记为不可JSON编码。 如果您希望保留例如grpc-gateway google.api.http批注，则需要使用protoc-gen-dump而不是protoc-gen-json 。
【Libsvm】Win10环境下Matlab 2016b的Libsvm编译方法
toseekin的专栏
11-24 165
LIBSVM是台大林智仁(Lin Chih-Jen)教授开发的支持向量机软件包，支持多种编程语言。为了在Matlab上做支持向量机分类，在Win10上编译libSvm软件包过程中遇到的问题，在这里总结一下。 1、libSVM软件包的下载： https://www.csie.ntu.edu.tw/~cjlin/libsvm/ 下载这个zip文件 下载后放在Matlab的Toolbox目录...
protoc & protoc-gen-go安装
yjk13703623757的博客
05-01 467
https://blog.csdn.net/m_shang/article/details/128175116
gRPC 提供接口文档
海纳百川
11-09 1285
在 RESULTful 接口服务中，我们可以使用 swagger 来展示当前服务接口列表，但是当我们的项目是使用的 gRPC 提供接口服务时，就没法使用 swagger 来做接口展示服务了。为了解决这个问题，本文将介绍加的方式来在线提供 gRPC 文档。
ubuntu安装protoc全过程 亲测有效
qq_44033530的博客
04-03 7946
命令行如下：git clone https://github.com/protocolbuffers/protobuf.git git clone https://github.com/protocolbuffers/protobuf.git sudo apt-get install autoconf automake libtool curl make g++ unzip cd protobuf/ git submodule update --init --recursive sudo ./autogen
如何更新我的protoc-gen-go插件
06-07
要更新 `protoc-gen-go` 插件，可以使用以下命令： ``` $ go get -u github.com/golang/protobuf/protoc-gen-go ``` 该命令将下载最新版本的插件并安装在 `$GOPATH/bin` 目录下。如果该目录已经在 PATH 环境变量中，那么你就可以直接使用最新版本的插件了。 如果你需要安装指定版本的插件，可以使用 `@<version>` 后缀，例如： ``` $ go get -u github.com/golang/protobuf/protoc-gen-go@v1.4.3 ``` 该命令将下载 `v1.4.3` 版本的插件。 注意：在更新插件之前，建议备份你的项目，以免出现不兼容的情况。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 6
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值