社区微信群开通啦,扫一扫抢先加入社区官方微信群
社区微信群
beego
前,需要做好如下准备
golang
语言GOPATH
、GOBIN
git
beego
安装包 go get github.com/astaxie/beego
bee
工具 go get github.com/beego/bee
git
进入$GOPATH/src
bee version
$ bee version
______
| ___
| |_/ / ___ ___
| ___ / _ / _
| |_/ /| __/| __/
____/ ___| ___| v1.10.0
├── Beego : 1.10.1
├── GoVersion : go1.9.2
├── GOOS : windows
├── GOARCH : amd64
├── NumCPU : 4
├── GOPATH : C:UsersXXXgo
├── GOROOT : C:Go
├── Compiler : gc
└── Date : Tuesday, 9 Oct 2018
bee
提供了很多命令行工具,具体可参考 beego官网cd
到 $GOPATH/src
目录bee api 项目命
即可创建项目bee api beegoApi
创建一个叫 beegoApi
的项目$ cd $GOPATH/src && bee api beegoApi
______
| ___
| |_/ / ___ ___
| ___ / _ / _
| |_/ /| __/| __/
____/ ___| ___| v1.10.0
2018/10/09 13:54:23 INFO ▶ 0001 Creating API...
create C:UsersXXXgosrcbeegoApi
create C:UsersXXXgosrcbeegoApiconf
create C:UsersXXXgosrcbeegoApicontrollers
create C:UsersXXXgosrcbeegoApitests
create C:UsersXXXgosrcbeegoApiconfapp.conf
create C:UsersXXXgosrcbeegoApimodels
create C:UsersXXXgosrcbeegoApirouters
create C:UsersXXXgosrcbeegoApicontrollersobject.go
create C:UsersXXXgosrcbeegoApicontrollersuser.go
create C:UsersXXXgosrcbeegoApitestsdefault_test.go
create C:UsersXXXgosrcbeegoApiroutersrouter.go
create C:UsersXXXgosrcbeegoApimodelsobject.go
create C:UsersXXXgosrcbeegoApimodelsuser.go
create C:UsersXXXgosrcbeegoApimain.go
2018/10/09 13:54:23 SUCCESS ▶ 0002 New API successfully created!
bee generate docs
生成符合 swagger
使用的两个文档 swagger.json
和 swagger.yml
bee run -downdoc=true
更新 swagger-ui
,如果 swagger
目录没有 swagger-ui
则会自动下载安装bee run -gendoc=true
让项目重新编译也会生成 swagger
文档bee run -gendoc=true -downdoc=true
结合两个方法$ bee run -gendoc=true -downdoc=true
______
| ___
| |_/ / ___ ___
| ___ / _ / _
| |_/ /| __/| __/
____/ ___| ___| v1.10.0
2018/10/09 14:29:57 INFO ▶ 0001 Using 'beegoApi' as 'appname'
2018/10/09 14:29:57 INFO ▶ 0002 Initializing watcher...
beegoApi/routers
beegoApi
2018/10/09 14:29:58 INFO ▶ 0003 Generating the docs...
2018/10/09 14:29:58 SUCCESS ▶ 0004 Docs generated!
2018/10/09 14:29:59 SUCCESS ▶ 0005 Built Successfully!
2018/10/09 14:29:59 INFO ▶ 0006 Restarting 'beegoApi.exe'...
2018/10/09 14:29:59 SUCCESS ▶ 0007 './beegoApi.exe' is running...
2018/10/09 14:29:59.297 [I] [router.go:269] C:UsersXXXgosrcbeegoApicontrollers no changed
2018/10/09 14:29:59.306 [I] [router.go:269] C:UsersXXXgosrcbeegoApicontrollers no changed
2018/10/09 14:29:59.355 [I] [asm_amd64.s:2337] http server Running on http://:8080
[beego] 2018/10/09 - 14:30:12 | 127.0.0.1| 304 | 0s| match| GET /swagger/
[beego] 2018/10/09 - 14:30:13 | 127.0.0.1| 200 | 0s| match| GET /swagger/swagger.json
[beego] 2018/10/09 - 14:30:13 | 127.0.0.1| 200 | 0s| match| GET /swagger/favicon-32x32.png
http://127.0.0.1:8080/swagger/
就会得到如下的界面了使用 Swagge
测试
手动测试
如果觉得我的文章对您有用,请随意打赏。你的支持将鼓励我继续创作!