beego API开发入门教程

下载 beego

• 下载 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:\Users\XXX\go
├── GOROOT    : C:\Go
├── Compiler  : gc
└── Date      : Tuesday, 9 Oct 2018

• 说明安装成功
• bee 提供了很多命令行工具，具体可参考 beego官网

---

创建 beego API 项目

• 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:\Users\XXX\go\src\beegoApi
        create   C:\Users\XXX\go\src\beegoApi\conf
        create   C:\Users\XXX\go\src\beegoApi\controllers
        create   C:\Users\XXX\go\src\beegoApi\tests
        create   C:\Users\XXX\go\src\beegoApi\conf\app.conf
        create   C:\Users\XXX\go\src\beegoApi\models
        create   C:\Users\XXX\go\src\beegoApi\routers\
        create   C:\Users\XXX\go\src\beegoApi\controllers\object.go
        create   C:\Users\XXX\go\src\beegoApi\controllers\user.go
        create   C:\Users\XXX\go\src\beegoApi\tests\default_test.go
        create   C:\Users\XXX\go\src\beegoApi\routers\router.go
        create   C:\Users\XXX\go\src\beegoApi\models\object.go
        create   C:\Users\XXX\go\src\beegoApi\models\user.go
        create   C:\Users\XXX\go\src\beegoApi\main.go
2018/10/09 13:54:23 SUCCESS  ▶ 0002 New API successfully created!

---

配置 配置 Swagge

• Swagger 是一套围绕OpenAPI规范构建的开源工具，可以帮助我们设计，构建，编写和使用 REST API
• 使用 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:\Users\XXX\go\src\beegoApi\controllers no changed
2018/10/09 14:29:59.306 [I] [router.go:269]  C:\Users\XXX\go\src\beegoApi\controllers 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/ 就会得到如下的界面了
  

---

测试 API 接口

• 使用 Swagge 测试
  

• 手动测试