锐客网

  1. 首页 > 睿知 > it技术 > >

go语言gin Go语言gin框架从入门到精通

IT技术代码

go语言框架gin之集成swagger1.先安装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 标签
// @Producejson
// @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 标签
// @Producejson
// @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 标签
// @Producejson
// @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.查看接口文档 ：
8.ok,完成
GoLang -- Gin框架? 何为框架：
框架一直是敏捷开发中的利器，能让开发者很快的上手并做出应用 ， 甚至有的时候，脱离了框架，一些开发者都不会写程序了 。成长总不会一蹴而就 ， 从写出程序获取成就感，再到精通框架，快速构造应用，当这些方面都得心应手的时候，可以尝试改造一些框架，或是自己创造一个 。
Gin是一个golang的微框架，封装比较优雅，API友好 ， 源码注释比较明确，已经发布了1.0版本 。具有快速灵活，容错方便等特点 。其实对于golang而言 ， web框架的依赖要远比Python，Java之类的要小 。自身的net/http足够简单，性能也非常不错 。框架更像是一些常用函数或者工具的集合 。借助框架开发，不仅可以省去很多常用的封装带来的时间 ， 也有助于团队的编码风格和形成规范 。
（1）首先需要安装，安装比较简单，使用go get即可
go getgithub.com/gin-gonic/gin
如果安装失败，直接去Github clone下来，放置到对应的目录即可 。
（2）代码中使用：
下面是一个使用Gin的简单例子：

推荐阅读


上一篇：redis使用教程视频，redis妙用

下一篇：路由器怎么检查好坏，路由器如何检查正常