beego集成swagger

时间:2024-03-21 07:22:15

背景

最近在做的一个项目为前端提供rest接口,编程语言为go,框架采用的是beego,在beego框架中集成swagger可以很方便的展示已经实现的后端rest接口。

前提

beego框架的安装和使用可以直接参考beego官网,文档也是中文的,可读性很高。

步骤

1 创建beego项目:
通过bee api hello 命令创建hello项目。

2 swagger的版本不同的话展示的效果会不一样,github上beego项目下的swagger应该是对beego支持最好的,可以显示出你定义的model数据结构,因此建议
https://github.com/beego/swagger下载最新的swagger包,命名为swagger.zip,放置在hello目录下

3 运行beego项目,bee run -gendoc=true -downdoc=true 启动项目,打开http://localhost:8080/swagger即可看到接口的界面。

-gendoc=true 表示每次自动化的 build 文档,-downdoc=true 会自动的下载 swagger 文档查看器(如果hello目录下没有swagger.zip的话会自动下载,不过还是建议在github上下载好)
beego集成swagger