Swagger

Swagger 是一个 API 文档生成工具，可以根据代码注释生成 API 文档。
项目中使用 Gin-Swagger生成 API 文档，方便查看和调试接口。 在线文档地址

介绍

Go Gin Boilerplate 使用 Gin-Swagger 生成 API 文档，方便查看和调试接口。

需求

在平时的开发过程中，我们需要编写接口文档，方便前端开发人员查看和调试接口。 一般我们会有以下几点主要的需求：

• 接口文档生成，根据代码注释快速生成接口文档
• 接口文档查看，方便共享给其他开发人员查看
• 接口文档调试，能够在线调试，尽可能的和目前开发环境保持一致

使用

在终端执行以下命令

make swagger

会看到在 api/swagger 目录下生成相关内容