使用swagger生成接口文档案例

使用swagger生成接口文档

package main

import (
	"github.com/gin-gonic/gin"
	ginSwagger "github.com/swaggo/gin-swagger"
	"github.com/swaggo/gin-swagger/swaggerFiles"
	_ "main/docs"
	"net/http"
)

// Test
// @Summary 学生登录
// @Product json
// @Accept mpfd
// @Tags 登录
// @Param username formData string true "用户名"
// @Param userpassword formData string true "密码"
// @Success 200 {string} string "{code:200,msg:"Login success!"}"
// @Router /student/form [post]
func Test(c *gin.Context) {
	username := c.PostForm("username")
	password := c.PostForm("userpassword")
	c.String(http.StatusOK, "username:%s,password:%s,type:%s", username, password)
}

// @title 学生管理系统
// @version 1.0(版本)
// @description 实现用户的增删改查
// @termOfService http://swagger.io/terms/
// @contact.name zxp
// @contact.url http://www.swagger.io/support
// @contact.email support@seagger.io
// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html
// @host localhost:8080
// @BasePath
func main() {
	//实例化一个默认的gin实例
	r := gin.Default()
	r.POST("/form", Test)
	r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
	r.Run()
}

注意点：

1. 获取依赖
   “github.com/swaggo/gin-swagger”
   “github.com/swaggo/gin-swagger/swaggerFiles”
2. 编写完成后，输入命令 swag init 会生成docs目录
   
   把docs目录加入（ _ “main/docs” ）如图
   
3. 把你的项目程序运行起来，打开浏览器访问http://localhost:8080/swagger/index.html就能看到Swagger 2.0 Api文档了。