使用Beego搭建Go语言的Restful API项目
概述
此文章是Go语言开发项目的入门篇,hello word级别,主要讲解基于框架开发go项目的搭建过程。
搭建如下:
1.需要安装go语言,并配置环境变量。
2.需要安装git版本控制工具。
3.需要安装beego,beego是目前比较流程的go语言开发框架。
4.需要安装bee工具,这个工具是beego配套的,可以快速生成beego框架。
5.安装MySQL,bee工具可以根据MySQL中的表自动生成beego框架中的增删改查代码,特别方便。
1.Go环境配置
go语言官方下载地址:https://golang.org/dl/
windows版本就下载 .msi 后缀的安装包,然后傻瓜式安装。
安装完成后需要配置环境变量。
1.1、GOROOT
GOROOT的值对应你安装Go的路径,默认安装路径是:c:\Go,具体配置你的安装路径。
1.2、PATH
在PATH变量中配置追加:%GOROOT%\bin
保存配置,这是打开命令行输入 go version
这时就配置成功了。
1.3、GOPATH
GOPATH:beego开发目录
GOPATH/bin:bee可执行文件会存放在里面
创建一个文件夹当作Go的开发目录,然后配置这个目录到GOPATH环境变量
配置GOPATH的bin目录到Path下
到此配置完毕
2. 安装Git
官网下载地址:https://git-scm.com/downloads
具体安装自己摸索
3.安装bee、beego
3.1 beego
beego 的安装是典型的 Go 安装包的形式:
go get github.com/astaxie/beego
3.2 bee工具
您可以通过如下的方式安装 bee 工具:
go get github.com/beego/bee
安装完之后,bee
可执行文件默认存放在 $GOPATH/bin
里面(如下图),所以您需要先把 $GOPATH/bin
添加到您的环境变量中,才可以进行下一步。
运行bee命令,如下图所示则表示安装成功
4.安装MySQL
1.下载MySQL 我用的是5.7.24
打开下载链接:https://dev.mysql.com/downloads/windows/installer/5.7.html
傻瓜式安装。
5.使用bee工具生成beego工程
5.1 生成api项目主体架构
在GOPATH目录下创建src文件夹
在src目录下打开cmd命令行工具
-- 此命令生成api项目,在命令行运行
bee api 项目名称
此时,beego的api项目就初始化生成了。
运行一下命令,运行项目,默认地址是:localhost:8080/swagger/
bee run -gendoc=true -downdoc=true
- -gendoc=true 表示每次自动化的 build 文档
- -downdoc=true 就会自动的下载 swagger 文档查看器
如下图启动成功
访问swagger
5.2 根据数据库表生成crud代码
数据库驱动器手动获取,命令如下:
go get github.com/go-sql-driver/mysql
生成代码命令
bee generate scaffold TABLENAME -fields="id:int64,name:string,gender:int,age:int" -driver=mysql -conn="root:123456@tcp(127.0.0.1:3306)/beego01"
- TABLENAME:需要自动生成代码的表
- -fields:需要生成代码的表字段
- -driver:数据库类型
- -conn:数据库连接
注意:此命令要在项目目录下运行
- 在MySQL中创建 beego01数据库
- 在beego01数据库中创建表
- 修改生成代码命令,并运行生成代码。
- 配置route路径
在routers目录下router.go文件中配置路径
func init() {
ns := beego.NewNamespace("/v1",
beego.NSNamespace("/object",
beego.NSInclude(
&controllers.ObjectController{},
),
),
// 新增的路径
beego.NSNamespace("/user",
beego.NSInclude(
&controllers.UserController{},
),
),
)
beego.AddNamespace(ns)
}
- 再次运行生成文档命令,重新生成swagger文档
如下所示,配置的路径生成了文档
bee run -gendoc=true -downdoc=true
6.开发Go语言工具
我使用的是GoLand,官方下载安装即可。
6.1 配置
直接新增配置即可,然后运行,这样就可以开发go项目了。