go语言框架gin之集成swagger

Python016

go语言框架gin之集成swagger,第1张

1.先安装Go对应的开源Swagger相关的库

go get github.com/swaggo/swag/cmd/swag

go get github.com/swaggo/gin-swagger

go get github.com/swaggo/files

go get github.com/alecthomas/template

2.验证是否安装成功：swag -v

3.针对接口写入注解

// @Summary 获取多个标签

// @Tags 标签

// @Produce  json

// @Param name query string false "标签名称" maxlength(100)

// @Param state query int false "状态" Enums(0, 1) default(1)

// @Param page query int false "页码"

// @Param page_size query int false "每页数量"

// @Success 200 {object} model.TagSwagger "成功"

// @Failure 400 {object} errcode.Error "请求错误"

// @Failure 500 {object} errcode.Error "内部错误"

// @Router /api/v1/tags [get]

func (t Tag) List(c *gin.Context) {

}

// @Summary 新增标签

// @Tags 标签

// @Produce  json

// @Param name body string true "标签名称" minlength(3) maxlength(100)

// @Param state body int false "状态" Enums(0, 1) default(1)

// @Param created_by body string false "创建者" minlength(3) maxlength(100)

// @Success 200 {object} model.Tag "成功"

// @Failure 400 {object} errcode.Error "请求错误"

// @Failure 500 {object} errcode.Error "内部错误"

// @Router /api/v1/tags [post]

func (t Tag) Create(c *gin.Context) {

}

// @Summary 更新标签

// @Tags 标签

// @Produce  json

// @Param id path int true "标签ID"

// @Param name body string false "标签名称" minlength(3) maxlength(100)

// @Param state body int false "状态 (0为未删除、1为已删除)" Enums(0, 1) default(1)

// @Param modified_by body string true "修改者" minlength(3) maxlength(100)

// @Success 200 {array} model.Tag "成功"

// @Failure 400 {object} errcode.Error "请求错误"

// @Failure 500 {object} errcode.Error "内部错误"

// @Router /api/v1/tags/{id} [put]

func (t Tag) Update(c *gin.Context) {

}

4.针对整个项目进行注解，直接在main方法写入如下注解

//@title 项目名称

//@version 1.0

//@description 这里是描述

func main() {

5.生成执行 swag init

这时会在我项目的docs文件夹下面生成docs.go、swagger.json、swagger.yaml三个文件

6.要在routers中进行默认初始化和注册对应的路由：

r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

同时要引用 _"blog-service/docs" ，不然会报错

7.查看接口文档 ： http://localhost:9090/swagger/index.html

8.ok,完成

type Movie struct {

    Title string

    Year int `json:"released"`

    Color bool `json:"color,omitempty"`

    Actors []string

}

红圈里面叫做tag，标签的用于解释struct中字段对应到json中的字段，就是作个对应，tag里面加上omitempy，可以在序列化的时候忽略0值或者空值，还可以加上类型说明的type，

type，有些时候，我们在序列化或者反序列化的时候，可能结构体类型和需要的类型不一致，这个时候可以指定,支持string,number和boolean

比如 Title 可以定义为

Title string `json:"title int"` 对应成id类型

Java是一门较为成熟的语言,相对于C++要简单的多,C++里没有内存回收,所以比较麻烦,Java加入了内存自动回收,简单是简单,却变慢了,go语言是一门新兴的语言,现在版本是1.9 ? go语言的性能比Java要好,但由于出现晚,资料较Java少,有些Java的功能go也没有,并且有许多的软件是支持Java但支持go的很少.所以在短期内Java是比go通用的

C语言的最大的优势是时间性能好,只比汇编慢20%~30%,C++最大的优势是快且面向对象,Java最大的优势是垃圾回收机制,GO语言的目标是具备以上三者的优势