go语言框架gin之集成swagger

Python021

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,完成

大家好，我是谢伟，是一名程序员。

下面的学习是一个系列，力求从初学者的角度学会go 语言，达到中级程序员水平。

这一系列是我的输出总结，同时我还推出了视频版。正在制作过程。

为写出这些文章，我阅读了网上诸多热门的教程和纸质书籍。内容的实质都是那些，要区分出差异的话，只能表现在具体实例层面。所以，实例我会选取自己在工作中的项目实例抽取出来。希望对大家有所帮助。

我们已经研究了：

本节的主题是：接口

接口是 golang 中最值得强调的特性。它让面向对象，内容组织实现非常的方便。

接口在 go 语言中是一系列方法的集合，原则上方法可以有很多个，但建议4个左右。

上文中定义了一个 httpClient 的接口，指定了这个接口可以干这些活： Get、Post、Put、Delete

上文中指定了 httpClient 接口，指定了这个接口需要干的活是： Get、Post、Put、Delete ， 具体的实现需要靠其他结构体来实现。

一个结构体实现了接口要求的所有的方法(方法的参数和返回值一致)，那么就说这个结构体实现了这个接口

上文中的使用： httpClient 屏蔽了 httpImpl 的内部细节，而依然可以使用 Get 方法，去完成任务。

当然接口可以被诸多结构体实现，只需存在接口定义的几种方法即可。

接口和结构体的定义很相似，也可以完成嵌入接口的功能，嵌入的匿名的接口，可以自动的具备被嵌入的接口的方法。

结构体实现 String 方法即可实现结构化输出结构体。

实现Error 方法即可自定义错误类型。

这几个读写接口在好些库中实现了，后续我们再讨论。

Any 类型

空接口在 go 里，可以当成任意类型，意味着，比如你的函数或者方法不知道传入的参数的类型，可以直接定义为 interface{}

类型断言

类型断言的使用场景是：接口类型的变量可以包含任何类型的值。如何判断变量的真实类型？

比如解析一个不知道字段类型的 json， 常常需要使用到类型断言。

可以使用：

ok...idiom

varInterface.(T), varInterface 必须是接口、T 则是具体的实现接口的结构体

switch ..case...

.(type) 只在 switch 语句里才能使用。

以上就是接口的全部内容，接口是go 中最特别的特性。借助 接口， go 实现面向对象中的继承和多态。

接口是方法的集合，只定义具体要干什么，而怎么干，则由其他的结构体的方法实现。这样不同的结构体的方法的具体处理不同，实现的接口的功能就不一样。

尽管如此，接口并不意味着可以随意滥用。我们最好是根据面向对象的客观实体，抽象出接口和方法。

本节完，再会。

在正常的测试中，当我们需要进行接口测试时，通常使用接口调试工具，如postman进行接口测试

目前我在尝试使用Go语言进行接口测试，使用的库均为Go自带的库。

注：当前采用的接口为时事新闻接口，每天可以请求100次，需要的同学，可以自行使用。