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

<p>最近因为跟客户端联调的时候写错了一个字段的类型，扯皮了很久。为了避免后续再扯皮，写了个从 gin 项目导出 swagger （底层是 <a href="https://github.com/swaggo/swag" rel="nofollow">swaggo/swag</a>）并上传到 yapi 的小工具。</p> <h2>安装</h2> <h3>go install</h3> <pre><code class="language-bash">go install github.com/leslieleung/<a href="/cdn-cgi/l/email-protection" class="__cf_email__" data-cfemail="037a626264436f6277667077">[email&nbsp;protected]</a> </code></pre> <h2>快速开始</h2> <h3>在项目目录下创建一个 <code>yaag.yaml</code></h3> <p>可以将 <code>example/yaag.yaml</code> 复制到项目根目录，或者使用 <code>yaag -init</code> 来创建一个。</p> <h3>填写 <code>yaag.yaml</code></h3> <pre><code class="language-yaml">docDir: "" # swagger.json 生成目录 mergeMode: "" # Yapi 合并模式， 见 http://yapi.smart-xwork.cn/doc/openapi.html swagGeneral: "" # API 基础信息注解的目录, 默认为 main.go yapiUrl: "" # Yapi 的 url yapiToken: "" # Yapi 项目的 token </code></pre> <h3>安装 swag 并写注解</h3> <pre><code class="language-bash">go install github.com/swaggo/swag/cmd/<a href="/cdn-cgi/l/email-protection" class="__cf_email__" data-cfemail="daa9adbbbd9ab6bbaebfa9ae">[email&nbsp;protected]</a> </code></pre> <p>更多详情请参考 <a href="https://github.com/swaggo/swag" rel="nofollow">swaggo/swag</a> 。</p> <h3>运行 <code>yaag</code></h3> <p>项目地址 <a href="https://github.com/LeslieLeung/yaag" rel="nofollow">https://github.com/LeslieLeung/yaag</a> 欢迎 star 。</p>