go语言框架gin之集成swagger

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

我们是于2013年成立的成都网站建设公司,提供网站建设,电商网站设计开发,外贸营销网站建设,响应式网页设计,微信小程序开发、等服务。为客户创造有价值的品牌营销体验，让互联网提升企业的竞争力！

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.查看接口文档 ：

8.ok,完成

go语言新建项目

一直直接操作的框架 使用vscode 打开就会自动装包，这次想写一个简单应用，确不会怎么建项目，记录如下。

go1.14 后，以及不再需要把项目写在GOPATH下，所有不需要再配置。

配置GOPRXY goenv-w GOPROXY=(国内无法访问)

使用go mod方法新建项目。

任意位置新建文件夹。

文件夹下执行go mod xxx ，生成一个go.mod文件。

新建一个main.go文件，就可以直接运行了。

我开始的时候，先建了main.go文件，再执行的go.mod。后面没法运行。

参考：李文周的博客。

go语言web框架beego安装(go mod方式)

go语言web框架beego安装(go mod方式)_不忘初心，方得始终-CSDN博客

重要:将bee命令放到GOROOT/bin目录下，这步很关键

cp bee /usr/local/go/bin/

注：或者可以将GOPATH/bin设置为环境变量

echo ’export PATH=" PATH"' ~/.bashrc

source ~/.bashrc

router路由下方法名要大写,访问权限

wq保存

生效环境变量: source /etc/profile

go build -o abc.exe可指定编译后的文件名

Golang常用环境变量说明与设置详解

环境变量GOBIN表示我们开发程序编译后二进制命令的安装目录。

当我们使用go install命令编译和打包应用程序时，该命令会将编译后二进制程序打包GOBIN目录，一般我们将GOBIN设置为GOPATH/bin目录。

export GOBIN=$GOPATH/bin

Go get包管理mod

windows下默认项目路径在go安装目录的src下(beego)

Go语言做Web应用开发的框架，哪一个更适合入门

Revel Web开源框架

个高效的Go语言Web开发框架, 其思路完全来自 Java 的 Play Framework。

特点

热编译，简单可选，同步(每个请求都创建自己的goroutine来处理。

Go语言Web框架：beego

一个用Go开发的应用框架，思路来自于tornado，路由设计来源于sinatra。

支持特性

MVC；

REST；

智能路由；

日志调试；

配置管理；

模板自动渲染；

layout设计；

中间件插入逻辑；

方便的JSON/XML服务；

网站栏目：go语言框架搭建 go语言集成开发环境
网页链接：http://azwzsj.com/article/hgdjgo.html