使用swag生成API文档 swagger介绍 Swagger是用来描述RESTful API的接口语言,可以帮助开发者自动生成在线API接口文档以及功能测试代码。
swag可以将golang的注释转化为Swagger 2.0文档,支持多种golang Web框架,可以快速集成到我们的项目中。
使用gin-swagger 对接口代码添加注释 为应用添加注释(这里是通用的API信息)
代码示例如下
// @title Swagger Example API // @version 1.0 // @description 这个一个demo // @contact.name thinkmo // @contact.email tryit0714@gmail.com func main(){ } 主要注释如下
注释 说明 示例 title 必填 应用程序的名称。 // @title Swagger Example API version 必填 提供应用程序API的版本。 // @version 1.0 description 应用程序的简短描述。 // @description This is a sample server celler server.