第一步:创建项目,执行 bee api beegoApi
beegoApi:目录结构如图所示:(在这里多说一句,bee new 项目名 和 bee api 项目名 ,这两个命令最后生成的项目区别,在于后者别前者少一个 views目录)
第二步:配置 swagger
- 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
结合两个方法
执行完成,就会发现。项目beegoApi目录下,就会多出一个swagger目录。
至此,swagger已经配置好了,接下来在浏览器中 look 一下。
第三步:新建一个自己的控制器,看一下 swagger上是否会展示
test.go文件的内容如下:
package controllers
import (
beego "github.com/beego/beego/v2/server/web"
)
// Test API
type TestController struct {
beego.Controller
}
// @Title GetAll
// @Success 200 string
// @router / [get]
func (u *TestController) GetAll() {
u.Data["json"] = "我是测试控制器"
u.ServeJSON()
}
第四步:刷新一下浏览器,会发现。swagger多出一个 test API
当然也可以通过浏览器,直接访问url地址。如图所示:
补充:如果项目或者项目组不想使用 swagger,那就直接删除 beegoApi 入口文件 main.go 中的 if 判断即可。
只留下beego.run(),这样就不用向swagger那样,每当写一个函数,就要规范的加上注释。个人建议,还是规
范的好,规范起来,方便自己,有益他人。