使用Swagger生成JAVA Mock Server(Springboot)代码

Swagger为我们提供了非常多的工具,其中最强的还要算这个代码的生成工具。在前后端分离的大环境下,前后端之间订立的接口显得尤为重要,接口在订立之后变动的可能性已经很小,这就要求我们提前去设计接口,也就是我们为前端提供的API。


但是我们发现,在开发过程中订立的接口寿命其实很短,这是一件非常严重的事情。因此Swagger为我们提供了另外一种比较优雅的方式:就是你先订立接口,然后再去生成接口;也就是使用接口文档去生成代码,这是非常好的一种实践方式。


Mock Server为我们解决下面的问题:
1、我们设计了API,但后台还没有开发完成;
2、因为网络等原因,导致直接调用真实的后台API会很不稳定或者很耗时。

前期准备
先看下面文章,如何生成API文档,拿到文档后,我们才能生成Mock Server Code
SpringBoot中使用Swagger生成RESTful规范API文档
http://blog.csdn.net/a78270528/article/details/78506338

实现步骤:
1、访问:http://localhost:8090/v2/api-docs,会返回接口的JSON数据,复制(文章最后有完整JSON代码)。




2、再打开Swagger Editor(https://editor.swagger.io),也可以下载代码,在本地部署访问。我们这里使用在线方式,粘贴刚刚复制的JSON,提示转成YAML:




3、点击Generate Server,选择spring,直接弹出下载代码。


4、解压后,就是一个完整的Spring Boot工程,Import(Projects from Folder or Achive)到我们的MyEclipse:




5、这时候我们可以正常启动项目,Swagger2SpringBoot,右键Run as..


6、这里面推荐一个工具Postman,最好使用Chrome下的插件方式安装,单独的Postman不支持中文。在Postman中访问我们之前编写的接口:




7、我们按照接口要求填写了接口,发送后返回HTTP请求415错误 – 不支持的媒体类型(Unsupported media type)


8、解决方法是去除Swagger生成接口的Consumes,让其不限制请求类型:




9、修改后重启项目,再次发送请求,这回不是415了,变成了406错误(HTTP 406 Not acceptable,翻译过来是“不能接收”),因为Swagger生成的代码接口,必须指定Accept:




10、所以们在发送请求时在Headers中加入Accept: application/json,再次发送请求,这回返回提200,终于成功了:




11、,但却发现并没有返回内容,BODY是空,原因是Swagger生成的Mock Server只能判断接口是否调用成功,并不能返回需要的数据,如果需要返回一些假数据给前端进行测试,需要手动增加代码,我们在第4步时红色框起来的两个JAVA类,UserApi是对应的接口,UserApiController是接口实现,我们需要修改UserApiController中对应的接口实现,以返回数据:




12、这时我们再次发送接口,返回如下:


  • 4
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 3
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

二一点

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值