为了账号安全,请及时绑定邮箱和手机立即绑定

Spring Boot使用Swagger做API管理,如何定义返回格式?

Spring Boot使用Swagger做API管理,如何定义返回格式?

小唯快跑啊 2019-10-17 09:14:14
问题描述在使用swagger管理API的过程中确实可以很方便的管理API,但是返回的数据格式该如何定义啊?问题出现的环境背景及自己尝试过哪些方法我们定义了通用的返回格式,但是Data的内容是不一样的,在ApiOperation设置response的话不能显示具体内容,在方法的返回类型使用泛型定义返回格式的话感觉会很乱。{"code":0,"msg":"string""data":{},}相关代码@ApiOperation(value="XX接口",httpMethod="POST",response=Result.class)publicResultxxxx{returnnewResult(xx);}你期待的结果是什么?实际看到的错误信息又是什么?感觉现在的做法非常别扭,有没有更好的解决办法?
查看完整描述

2 回答

?
慕容森

TA贡献1853条经验 获得超18个赞

推荐使用Rest风格的返回结构。
如果请求成功,可以直接返回data里面的数据,没必要再包一层code和msg,同时返回的httpcode为2xx
当请求失败时,返回统一的错误提示,这时就可以使用code和msg给出具体的错误信息,并且将返回的httpcode设为4xx或是5xx,同时还可以定义swagger异常返回的bean
                            
查看完整回答
反对 回复 2019-10-17
  • 2 回答
  • 0 关注
  • 926 浏览
慕课专栏
更多

添加回答

举报

0/150
提交
取消
意见反馈 帮助中心 APP下载
官方微信