本文介绍了如何在 Gin 框架中集成 Swagger，使用 Swagger 自动生成 API 文档。通过添加注释到 Go 代码，Swagger 能自动生成详细的接口文档，包括接口描述、请求和响应格式，简化了文档编写工作。文章详细讲解了安装 Swagger、配置项目、编写注释以及查看生成的文档的过程。
你喜欢写文档吗？我喜欢。
所以说文档成了开发心中的一个痛。尤其是使用 restful 接口，成了必须要写文档，否者前端同学根本不知道你写了什么。那么让我写文档，还不如杀了我呢！！！
接下来介绍一款神器 --- swagger
?什么是swagger
Swagger 是一个 API 生成工具，可以生成文档。Swagger 是通过编写 yaml 和 json 来实现文档化。并且可以进行测试等工作。
通过 swagger 可以方便的生成接口文档，方便前端进行查看和测试。
?安装 swagger
上面说了一堆 swagger 怎么样，说到头还是要自己编写？其实并不是的，让我们的项目中集成 swagger，以后项目的接口文档便可以自动生成。
首先要安装 swagger 。
等待安装完成，在我们的终端中执行 swag init，目录为根目录，于 main.go 同目录。
执行完成后，会在根目录下新建一个 docs 文件夹。
接下来就可以完善项目了。
将下面两行放入 initRouter 中的 import 中。
选择 Sync packages of GinHello,此时 IDE 就会自动帮我下载，并添加到 go.mod 中。
如果这里提示下载失败，请对 go mod 添加代理。
添加代理 File
最低0.47元/天 解锁文章
扫一扫
878
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
