swag

## 什么是swag？ Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。简单来说，可以更友好的展示自己对外的API，调用、测试更加方便、轻松。 下面的操作都是以maven构建的springboot项目为基础。 首先要做的就是引入swag的jar包 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.5.0</version> </dependency> 配置config类 @Configuration @EnableSwagger2 public class Swagger2 { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select() // 为当前包路径 .apis(RequestHandlerSelectors.basePackage("learn.controller"))

swagger 使用 安装 命令行工具 go get github.com/swaggo/swag/cmd/swag # 安装到$GOPATH/bin下 # 使用指令 swag 安装依赖包 注入到router.go中 import ( _ "sisyphus/docs" // 自动生成swag文件位置 "github.com/swaggo/gin-swagger" "github.com/swaggo/gin-swagger/swaggerFiles" ) // 使用gin路由 gin.engine engine.GET("/swagger/*any",ginSwagger.WrapHandler(swaggerFiles.Handler)) 编写注释 // @title Golang // @version 1.0 // @description An example // @termsOfService https://github.com/ // @license.name MIT // @license.url https://github.com//LICENSE func main(){ ... } // @Summary Get multiple article tags // @Produce json // @Param name query string

github地址： https://github.com/swaggo/gin-swagger 1、下载swag $ go get -u github.com/swaggo/swag/cmd/swag 2、在main.go所在目录执行 $ swag init 生成docs/doc.go以及docs/swagger.json,docs/swagger.yaml 3、下载gin-swagger $ go get -u github.com/swaggo/gin-swagger $ go get -u github.com/swaggo/files 然后在路由文件引入 import ( "github.com/gin-gonic/gin" swaggerFiles "github.com/swaggo/files" "github.com/swaggo/gin-swagger" _ "github.com/swaggo/gin-swagger/example/basic/docs" // docs is generated by Swag CLI, you have to import it. ) 并增加swagger访问路由 url := ginSwagger.URL("http://localhost:8080/swagger/doc.json") // The url