使用bee自动生成api文档

时间:2022-01-01 16:45:18

beego中的bee工具可以方便的自动生成api文档,基于数据库字段,自动生成golang版基于beego的crud代码,方法如下:

1、进入到gopath目录的src下执行命令:

bee api api_user -conn=root:root@tcp(127.0.0.1:)/api

api_user为api项目的名称,-conn指定链接的数据库地址,自动创建beego项目api的文档结构

2、切入到项目下面,继续执行:

bee run -downdoc=true -gendoc=true

自动下载beego集成的swagger文档,并运行swagger,总体效果如下:

使用bee自动生成api文档

使用bee自动生成api文档

使用bee自动生成api文档

3、浏览swagger,在浏览器中输入地址:http://localhost:8080/swagger/,集成的swagger测试页面如下:

使用bee自动生成api文档

点开之后,效果如下:

使用bee自动生成api文档

4、接下来是生成的项目结构:

使用bee自动生成api文档

发现里面的models、controller、main文件等均已自动生成,方便快捷。。。