0

0

Golang微服务中的API文档自动化方案_基于Proto生成的Swagger UI

P粉602998670

P粉602998670

发布时间:2026-02-12 16:07:30

|

162人浏览过

|

来源于php中文网

原创

必须在proto的rpc方法上添加google.api.http注解并导入annotations.proto,否则swagger为空;推荐使用protoc-gen-openapi生成openapi 3.0规范,注意路径参数名与request字段严格一致、body映射准确、避免oneof用于对外api。

golang微服务中的api文档自动化方案_基于proto生成的swagger ui

proto 文件里没加 google.api.http 注解,Swagger 就是空的

生成的 Swagger UI 里看不到任何接口,大概率是因为 proto 中只定义了 message 和 service,但没告诉工具“这个 RPC 方法对应哪个 HTTP 路径和方法”。protoc-gen-swagger 这类工具只认 google.api.http 扩展,不看 grpc-gateway 的 runtime 注册逻辑。

  • 必须在 .protorpc 方法上显式加注解,比如:
    rpc GetUser(GetUserRequest) returns (GetUserResponse) {
      option (google.api.http) = {
        get: "/v1/users/{id}"
      };
    }
  • 漏掉 import "google/api/annotations.proto"; 会导致编译失败,但有些 IDE 不报错,只静默跳过生成
  • get/post 路径里的字段名(如 {id})必须和 request message 中的字段名完全一致,大小写敏感

protoc-gen-openapi 还是 protoc-gen-swagger

两者都从 proto 生成 OpenAPI spec,但输出格式、兼容性和扩展能力差别不小。现在更推荐 protoc-gen-openapi,它原生支持 OpenAPI 3.0,而老版 protoc-gen-swagger 只到 2.0,Swagger UI v5+ 对 2.0 支持越来越弱。

  • protoc-gen-openapi 默认生成 openapi.yaml,可直接被 Swagger UI 或 Redoc 加载;protoc-gen-swagger 输出的是 swagger.json,需额外配置才能适配新版 UI
  • 如果用了 google.api.field_behavior(比如 REQUIRED),protoc-gen-openapi 能转成 OpenAPI 的 required 字段,老工具基本忽略
  • 命令行参数不同:--openapi-out=. vs --swagger_out=logtostderr=true:.,拼错就静默失败

生成的文档里 path 参数或 body 类型不对

常见现象是 Swagger 显示某个字段是 string,但实际 gRPC 接口要求的是 int64;或者 body 里该出现的字段没出现——这通常不是工具 bug,而是 proto 定义和 HTTP 映射没对齐。

Qoder
Qoder

阿里巴巴推出的AI编程工具

下载
  • HTTP path/query 中提取的字段(如 {user_id})必须在 request message 中声明为 scalar 类型(int64, string 等),不能是嵌套 message
  • request message 中未出现在 path 或 query 里的字段,默认进 body;但如果用了 body: "*",整个 message 当 body;用 body: "field_name" 则只取指定字段,其余丢弃 —— 文档会如实反映这个行为
  • gRPC 的 oneof 在 OpenAPI 里没有直接等价物,protoc-gen-openapi 会生成 anyOf,但部分 Swagger UI 版本渲染异常,建议避免在对外 API 的 request 中用 oneof

Swagger UI 页面加载后报 Failed to fetch 或 404

生成的 openapi.yaml 没问题,但 UI 打开后调用不到后端,多数是路径或 CORS 配置脱节,而不是文档生成环节的问题。

立即学习go语言免费学习笔记(深入)”;

  • 检查 Swagger UI 加载时请求的 /v1/swagger/openapi.yaml 是否真能返回内容(curl 一下),很多项目把文件放在 static/ 下但没配 Web 服务路由
  • UI 发起的 API 请求地址默认是相对路径,比如当前页是 http://localhost:8080/swagger/,它就会往 http://localhost:8080/v1/users/123 发请求 —— 如果你的 gRPC-Gateway 服务跑在另一个端口(如 8090),需要在 UI 初始化时设 urls.primaryName 或改 requestUrl
  • 浏览器控制台若报 CORS 错误,不是文档问题,是 gateway 服务没开 Access-Control-Allow-Origin,Gin/Chi 等框架需显式加 middleware
实际跑通的关键不在工具链多炫,而在 proto 注解、HTTP 映射、静态资源路由、网关服务这四层之间严丝合缝。少一层对齐,Swagger 就只是个好看的空壳。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

206

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

235

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

346

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

212

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

402

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

322

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

197

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

784

2025.06.17

2026春节习俗大全
2026春节习俗大全

本专题整合了2026春节习俗大全,阅读专题下面的文章了解更多详细内容。

189

2026.02.11

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Go 教程
Go 教程

共32课时 | 5万人学习

Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号