创建一个新的Gin项目或在现有项目中添加Swagger支持。 go mod init ${your-project-name} 步骤3:添加注释 在你的代码中添加Swagger注释。例如: packagemainimport("go-gin-swagger-demo/docs""net/http""github.com/gin-gonic/gin"swaggerfiles"github.com/swaggo/files"ginSwagger"github.com/swaggo/gin-swagge...
执行swag init命令后,项目根据会生成docs目录 下载gin-swagger相关的包 go get -u github.com/swaggo/gin-swagger go get-u github.com/swaggo/files 下载成功后,在main主函数,添加相关注解,并在项目启动前加入如下代码 app.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler)) //@contact.na...
3,添加注释用于生成swagger.json的信息,api文档接口信息 1)gin server实例化函数的上面加如下信息 //@title goweb project//@version 1.0//@description this is goweb server.//@host 127.0.0.1:8888//@BasePath /api/v1func NewGinHttpServer() { r :=gin.Default() r.GET("/swagger/*any", ginSwa...
r := gin.Default() r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler)) 例行公事 概要 后续swagger就是例行公事: 添加(修改)注释 生成配置文件,运行swag init 重启服务 查看结果http://localhost:你的端口/swagger/index.html
swagger 显示 image.png 附: postman调用 image.png 4.2 Path 代码 // DeleteServer 删除指定服务器// @Summary 删除指定服务器// @Description 删除指定服务器// @Tags 服务器管理// @Param uuid path string true "服务器uuid"// @Param project_num formData string true "项目编号"// @Success 200 {ob...
│ swagger.yaml 1. 2. 3. 4. 5. 6. 7. 8. 9. 例子 package main import ( "github.com/gin-gonic/gin" ginSwagger "github.com/swaggo/gin-swagger" swaggerFiles "github.com/swaggo/files" _ "hello/docs" // 这里需要引入本地已生成文档 ...
$ go get -u github.com/swaggo/gin-swagger $ go get -u github.com/swaggo/files 接下来就是完善项目中的注解代码了swagger 注解路由注册中添加swagger如我的项目中的路由注册如下: package coreimport ( "github.com/gin-gonic/gin" swaggerfiles "github.com/swaggo/files" ginSwagger "github.com/swag...
使用gin-swagger渲染在线接口文档页面 第一步:添加注释 在程序入口main函数上以注释的方式写下项目相关介绍信息。 package main // @title 这里写标题 // @version 1.0 // @description 这里写描述信息 // @termsOfService http://swagger.io/terms/
go get -u github.com/swaggo/gin-swagger go get -u github.com/swaggo/files 修改main.go,并编译。 浏览器访问: http://localhost:8000/swagger/index.html 即可看到 API 文档。 编译后的文件大小变化 使用前是 21M。 使用后是 33M。 发布方式 ...
Swagger 中需要将相应的注释或注解编写到方法上，再利用生成器自动生成说明文件 gin-swagger 给出的范例：// @Summary Add a new pet to the store// @Description get string by ID// @Accept json// @Produce json// @Param some_id path int true "Some ID"// @Success 200 {string} string"ok"/...