grpc protobuf接口文档生成插件

原创 已于 2022-12-29 17:33:14 修改 · 994 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java #开发语言

于 2022-12-29 17:29:11 首次发布
Maven-Protobuf-Doc是一款个人独立开发的开源插件，用于自动生成gRPC-protobuf API文档。该插件基于谷歌的protoc-gen-doc进行了二次封装集成，并需配合showdoc工具使用。支持Windows及Linux环境。

github：maven-protobuf-doc

个人独立开发grpc protobuf api文档生成插件，开源项目，欢迎各位大佬试用，积极接纳优化建议，喜欢的大佬来个☆☆☆

关于Maven-Protobuf-Doc

Maven-Protobuf-Doc
基于谷歌 protoc-gen-doc
进行的二次Java封装集成，轻松实现解析protobuf文件自动生成api文档接口，插件需结合 showdoc
文档工具使用，目前仅支持Windows、Linux环境下使用，后续持续更新，陆续推出各平台适配

使用教程

Maven坐标

<plugin>
    <</
最低0.47元/天 解锁文章
TodaySaturday
关注
【swagger+yapi】proto+grpc+swagger结合yapi命令生成接口文档
码农印象
11-15 2616
1、环境 操作系统：ubuntu 18.04 go版本：1.14.2 docker版本：19.03.1 docker-compose版本：1.24.0 2、gRPC环境安装 # 启用 module模式 GO111MODULE="on" # 配置 goproxy go env -w GOPROXY="https://goproxy.io,https://goproxy.cn,direct" # 安装 grpc $ go get -u google.golang.org/grpc 3、安装 Protoc
RPC gRPC ProtoBuf之间的关系
123456789
05-14 3677
文章目录RPCProtoBufmessage定义message扩展Services定义protoc(Protocol Compiler)gRPC编译gRPC(mac)编译examples/cpp/helloworld代码理解(examples/cpp/helloworld)proto文件(helloworld.proto)helloworld.grpc.pb.h(cc)文件同步RPC例子greeter_client.cc和greeter_server.cc异步RPC例子greeter_async_clien
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 。
gRPC 提供接口文档
海纳百川
11-09 1642
在 RESULTful 接口服务中，我们可以使用 swagger 来展示当前服务接口列表，但是当我们的项目是使用的 gRPC 提供接口服务时，就没法使用 swagger 来做接口展示服务了。为了解决这个问题，本文将介绍加的方式来在线提供 gRPC 文档。
protobuf3.x【上】
最新发布
编程技术圈
09-25 879
Protobuf是一种高效、跨语言的数据序列化协议，通过.proto文件定义数据结构，支持多种编程语言。相比JSON，Protobuf采用二进制格式，体积更小、解析更快，但可读性较差。其核心优势在于高性能、跨平台兼容性和清晰的接口契约。语法上，Protobuf支持消息定义、枚举、嵌套、重复字段等特性，通过字段编号实现版本兼容。适合RPC通信、游戏协议等高性能场景，而JSON更适合需要可读性的API交互。安装配置简单，生成代码便捷，是高效数据传输的理想选择。
protobuf生成的cpp库相关的API接口
weixin_43387492的博客
05-16 1127
protobuf语法：syntax = "proto2" 定义一个测试文件：test.proto 内容如下 syntax = "proto2"; message People { required int32 id = 1; optional string name = 2; optional string address = 3; repeated string phone = 4; } 使用protoc编译过后生成test.pb.h和test.pb.cc两个文件 关于required
AI时代Java 项目中生成 gRPC 接口文档，smart-doc 仍然是你的最佳选择！
shalousun的专栏
02-21 1159
AI时代Java 项目中生成 gRPC 接口文档，smart-doc 仍然是你的最佳选择！
C++下的gRPC与protobuf使用和介绍
yiyu20180729的博客
02-29 2460
gRPC 和协议缓冲区简介。本页介绍 gRPC 和协议缓冲区。gRPC 可以使用 协议缓冲区作为其接口定义语言 （IDL） 和基础消息 交换格式。如果你不熟悉 gRPC 和/或协议缓冲区，请阅读此内容！如果只想深入了解并首先查看 gRPC 的运行情况，请选择一种语言并尝试其快速入门。在 gRPC 中，客户端应用程序可以直接调用服务器应用程序上的方法 在不同的计算机上，就好像它是本地对象一样，使您可以更轻松地 创建分布式应用程序和服务。
gRPC（二）入门：Protobuf入门
林钟一的博客
10-31 3350
通过protubuf文档先了解一下protobuf语法。点击跳转Protocol Buffers ( Protobuf ) 是一种免费的开源 跨平台数据格式，用于序列化结构化数据。它是谷歌公司开发的一种数据描述语言，并于2008年开源。Protobuf刚开源时的定位类似于XML、JSON等数据描述语言，通过附带工具生成代码并实现将结构化数据序列化的功能。Protocol Buffers 是一种与语言、平台无关，可扩展的序列化结构化数据的方法，常用于通信协议，数据存储等等。
protobuf中文学习文档
11-18
3. **protoc-gen-*插件**: 可扩展编译器，生成特定用途的代码，如gRPC服务接口。 **七、protobuf与gRPC** gRPC是基于protobuf构建的一个高性能、开源的RPC框架，它允许开发者定义服务接口并使用protobuf定义消息...
protobuf-java-3.16.1-API文档-中文版.zip
05-09
赠送jar包：protobuf-java-3.16.1.jar； 赠送原API文档：protobuf-java-3.16.1-javadoc.jar； 赠送源代码：protobuf-java-3.16.1-sources.jar； 赠送Maven依赖信息文件：protobuf-java-3.16.1.pom； 包含翻译后的API文档：protobuf-java-3.16.1-javadoc-API文档-中文(简体)版.zip； Maven坐标：com.google.protobuf:protobuf-java:3.16.1； 标签：protobuf、java、google、jar包、java、中文文档； 使用方法：解压翻译后的API文档，用浏览器打开“index.html”文件，即可纵览文档内容。 人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。
gapi-grpc-rs:用于Google API的gRPC客户端库，由API定义文件自动生成
03-14
盖比·格拉普斯 用于Google API的gRPC客户端库，由API定义文件自动生成。 安装依赖项 pip3 install jinja2 下载最新的原始文件 ./utils/update.sh 建造 ./prebuild.py cargo build 文档 cargo doc --open
grpc-api-1.24.0-API文档-中英对照版.zip
05-03
赠送jar包：grpc-api-1.24.0.jar； 赠送原API文档：grpc-api-1.24.0-javadoc.jar； 赠送源代码：grpc-api-1.24.0-sources.jar； 赠送Maven依赖信息文件：grpc-api-1.24.0.pom； 包含翻译后的API文档：grpc-api-1.24.0-javadoc-API文档-中文(简体)-英语-对照版.zip； Maven坐标：io.grpc:grpc-api:1.24.0； 标签：api、grpc、jar包、java、中英对照文档； 使用方法：解压翻译后的API文档，用浏览器打开“index.html”文件，即可纵览文档内容。 人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。 双语对照，边学技术、边学英语。
proto:proto文件，包含生成http swagger文档的proto，以及生成grpc接口的proto
03-10
原型 proto文件，包含生成http swagger文档的proto，以及生成grpc接口的proto make swagger_gen # 生成swagger.json make ui_run # 本地8080跑ui查看接口文档
GoogleProtobuf Java api(离线版本)
04-13
protobuf Java版本的离线api，自己制作
grpc使用文档
weixin_48956318的博客
07-24 705
grpc使用文档，编写小项目时对grpc的学习总结
gRPC官方文档(通讯协议)
dcldz5007的博客
05-25 586
文章来自gRPC 官方文档中文版 HTTP2 协议上的 gRPC 本文档作为 gRPC 在 HTTP2 草案17框架上的实现的详细描述，假设你已经熟悉 HTTP2 的规范。产品规则采用的是ABNF 语法 大纲 以下是 gRPC 请求和应答消息流中一般的消息顺序： 请求 → 请求报头 *有定界符的消息 EOS 应答 → 应答报头 *有定界符的消息 EOS 应答 → (应答报头 *有定界符...
学习gRPC---生成protobuf
woyaoza的博客
08-16 145
2. 该路径下新建Protocbuild.bat。
gRPC 文档概述
小迷糊
06-10 496
gRPC 文档概述
如何一键生成grpc接口文档
07-01
在gRPC接口开发中，自动生成文档是一个重要的需求，尤其在多人协作或维护大型项目时。实现一键生成gRPC接口文档的方法通常依赖于一些成熟的工具和框架支持。以下是几种常见的方法： ### 1. 使用 `protoc` 插件生成文档 gRPC 接口定义基于 `.proto` 文件，可以使用 `protoc` 编译器结合插件来自动生成文档。例如，`protoc-gen-doc` 是一个常用的插件，它可以将 `.proto` 文件中的注释提取出来并生成 HTML、Markdown 等格式的文档。 ```bash protoc --doc_out=docs --doc_opt=html,proto.html your_service.proto ``` 该命令会根据 `your_service.proto` 文件内容生成 HTML 格式的文档，并输出到 `docs` 目录下[^1]。 ### 2. 使用 `buf` 工具链 `buf` 是一个现代化的 gRPC 工具链，支持对 `.proto` 文件进行 linting、breaking change 检测以及文档生成等功能。通过 `buf generate` 命令结合适当的配置文件（如 `buf.gen.yaml`），可以自动化生成文档。 首先，在 `buf.gen.yaml` 中定义生成规则： ```yaml version: v1 plugins: - name: doc out: ./docs opt: html ``` 然后运行以下命令： ```bash buf generate ``` 该命令会按照配置生成 HTML 文档[^1]。 ### 3. 使用 Swagger 或 OpenAPI 集成 虽然 gRPC 原生不直接支持 OpenAPI，但可以通过工具如 `grpc-gateway` 将 gRPC 接口转换为 RESTful API，并利用 Swagger UI 展示接口文档。此外，`protoc` 插件 `protoc-gen-openapiv2` 可以直接从 `.proto` 文件生成 OpenAPI 规范文件。 ```bash protoc --openapiv2_out=./swagger_output --openapiv2_opt=logtostderr=true your_service.proto ``` 生成的 OpenAPI 文件可以直接在 Swagger UI 中加载查看[^1]。 ### 4. 使用第三方工具 - **gRPC Debugging Tools**：某些调试工具（如 Postman 的 gRPC 客户端）也提供了文档生成的功能，可以通过其内置功能导出接口文档。 - **gRPC UI**：类似 `ghz` 的工具也可能提供文档生成能力，尽管它的主要功能是性能测试和负载测试[^2]。 ### 5. 集成 CI/CD 流程 为了实现“一键”生成文档的目标，可以将上述工具集成到 CI/CD 流程中。例如，在 GitHub Actions 中配置自动化任务，每次提交代码后自动更新文档。 ```yaml jobs: generate-docs: runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v2 - name: Install protoc and plugins run: | # 安装 protoc 和 protoc-gen-doc sudo apt-get install -y protobuf-compiler go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest - name: Generate docs run: | protoc --doc_out=docs --doc_opt=html,proto.html your_service.proto - name: Deploy docs uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./docs ``` 此工作流会在每次提交后生成文档并部署到 GitHub Pages 上，供团队成员访问。 ---
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值