写了个给 gin 项目生成 swagger.json 并自动上传到 yapi 的小工具

[LeslieLeung]

最近因为跟客户端联调的时候写错了一个字段的类型，扯皮了很久。为了避免后续再扯皮，写了个从 gin 项目导出 swagger （底层是 swaggo/swag）并上传到 yapi 的小工具。

安装

go install

go install github.com/leslieleung/yaag@latest

快速开始

在项目目录下创建一个 yaag.yaml

可以将 example/yaag.yaml 复制到项目根目录，或者使用 yaag -init 来创建一个。

填写 yaag.yaml

docDir: "" # swagger.json 生成目录
mergeMode: "" # Yapi 合并模式， 见 http://yapi.smart-xwork.cn/doc/openapi.html
swagGeneral: "" # API 基础信息注解的目录, 默认为 main.go
yapiUrl: "" # Yapi 的 url
yapiToken: "" # Yapi 项目的 token

安装 swag 并写注解

go install github.com/swaggo/swag/cmd/swag@latest

更多详情请参考 swaggo/swag 。

运行 yaag

项目地址 https://github.com/LeslieLeung/yaag 欢迎 star 。