使用 swag 工具通过代码注释自动生成合规 openapi v3 文档：需在 main.go 添加 @title 等元信息，每个 handler 上方写全 @summary、@tags、@success 及匹配路由的 @param，struct 字段须带正确 json tag，生成后用 swagger-cli 严格校验并纳入 git。
OpenAPI V3 是描述 Golang 微服务接口事实上的标准，但直接手写 openapi.yaml 容易漏字段、错格式、和实际代码脱节——真正靠谱的做法是用代码生成文档，而不是反向维护。
用 swag 自动生成 OpenAPI V3 文档
swag 是 Go 生态最成熟的注释驱动工具，它读取源码里的特殊注释（比如 // @Summary），生成符合 OpenAPI V3 规范的 docs/swagger.json。它不依赖运行时反射，不侵入业务逻辑，适合 CI 集成。
- 必须在
main.go或启动入口文件顶部加// @title MyService API等基础元信息，否则生成失败 - 每个 HTTP handler 函数上方要加完整注释块，至少包含
@Summary、@Tags、@Success，否则对应接口不会出现在文档里 -
@Param的in字段必须明确写path/query/header/body，写成formData会生成 OpenAPI v2 兼容结构，v3 不认 - 执行
swag init -g cmd/server/main.go -o docs/，注意-g指向的是含main()的文件，不是包路径
gin + swag 路由绑定常见错误
Gin 的路由参数名（如 :id）和 @Param 注释里的 name 必须完全一致，大小写敏感，否则文档里该参数显示为缺失或类型错误。
- 错误写法：
// @Param ID query string true "user id"—— 这里ID和路由GET /users/:id中的id不匹配 - 正确写法：
// @Param id path string true "user id"，且in设为path - 如果用
c.Param("id")取值，注释 name 就只能是id，不能是userId或其他别名 - 嵌套路由（如
/orgs/{org_id}/repos）需为每个 path param 单独写一条@Param
响应体结构必须用 struct 标签对齐 json 字段
OpenAPI 文档中的 response schema 来自 Go struct 的字段定义。如果 struct 字段没加 json: tag，或 tag 值和实际 JSON 输出不一致，文档就会显示空字段或错误类型。
立即学习“go语言免费学习笔记（深入）”；
- 例如返回
{"user_id": 123}，但 struct 写成UserID int `json:"user_id"`是对的；写成UserID int（无 tag）会导致文档里字段名变成UserID，类型却是integer，但实际响应是小写 key - 嵌套结构要逐层导出：内层 struct 字段也必须首字母大写 + 正确
jsontag，否则生成器跳过整个字段 - 使用指针字段（如
*string）表示可选字段，swag会自动设"nullable": true；用string类型则默认必填 - 不要在 handler 里用
map[string]interface{}构造响应体——swag无法推导 schema，文档里只显示object，没字段细节
验证 OpenAPI 文件是否真合规
生成的 swagger.json 看似能打开，不代表符合 OpenAPI V3 规范。很多工具（比如 Swagger UI）容忍松散语法，但网关、SDK 生成器（如 openapi-generator）会直接报错。
- 用官方校验工具：
npx @apidevtools/swagger-cli validate docs/swagger.json，它比浏览器预览严格得多 - 重点检查错误：
should NOT have additional properties（多写了非法字段）、should match exactly one schema（oneOf/anyOf用法错）、required property 'openapi' not found（版本声明缺失） - 生成的
info.version默认是1.0，建议在注释里显式写// @version 0.4.2，避免和 Git tag 或服务实际版本脱钩 - 如果用了
x-开头的扩展字段（如x-unit-test），确保它们只出现在paths或components下，不能挂在根节点，否则校验失败
最常被忽略的是：生成文档后没把 docs/ 目录纳入 Git，或者 CI 打包时漏掉该目录，导致部署后 /swagger/index.html 404。文档不是附属品，它和二进制一样是交付物的一部分。
