beego使用Swagger

第一步:创建项目,执行 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上是否会展示
在这里插入图片描述

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
在这里插入图片描述
在这里插入图片描述


1.执行完bee generate docs和bee run -gendoc=true -downdoc=true后,swagger应该可以正常启动了,这个时候如果点击接口报404的话,这里有个坑,要再执行一个bee generate routers,;
2.这里面可能会有一个坑,我用的是1.20版本的beego,在加载swagger后,启动后一直显示一个固定地址的接口: https://petstore.swagger.io/
在这里插入图片描述
问题原因就是上图中,index.html页面中的url写死了固定的地址,自己改成本地项目地址就好了,大概率是开发人员的坑。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值