1.项目
地址:http://beego.me/
文档首页:http://beego.me/docs/intro/
Github:https://github.com/beego
2.创建项目
使用go
安装包即可
1 | go get github.com/astaxie/beego |
如需要升级
1 | go get -u github.com/astaxie/beego |
安装工具
1 | go get github.com/beego/bee |
默认会安装的GOPATH
的目录bin
下面
备注:在安装之前需要设置GOPATH
变量为你的项目目录,如:
GOPATH="/path/to/project"
只能设置一个目录空间,当前无法设置多个使用:
分开,具体可以查看官方文档
在目录空间里面需要设置src
目录,存放源代码,其他的会自动生成bin
和pkg
目录
安装完之后,就是创建项目,如果需要创建MVC
项目,做web开发直接使用:
bee new projectName
如果创建API
项目,则使用:
bee api apiproject
上面的命令都需要在src目录下面创建,成功之后进入项目目录,启动项目:
bee go
之后就会运行项目,如果显示成功,则打开:
http://127.0.0.1:8080/
既可以看到运行的项目
3.集成文档
首先在项目中配置文件打开文档开关
EnableDocs = true
然后使用命令生成
bee generate docs
在docs
目录下就会自动生成docs.go
文件,在main.go
添加引入:
1 | _ "beeapi/docs" |
然后启动项目的时候使用下面的命令:
bee run watchall true
打开地址/docs
路径,就可以看到api
文档的json
格式,如果需要UI
风格,可以下载swagger
,放到项目目录下,文件夹名称问swagger
,然后再地址栏进入/swagger
就可以看到api
文档了