温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

swagger 返回值描述

发布时间:2020-03-27 09:09:45 来源:网络 阅读:16644 作者:liuhanling 栏目:软件技术

今天被前端训了一顿,慌得一逼,说你们写的接口,返回值写的是什么东西,只有公共的三个字段......


我们的API文档是基于 swagger 组件写的.如是有了下面的东东


示例:

swagger 返回值描述


1.1.           返回字段

1.1.1.  返回字段(对象)

1.     将现有接口 @ApiOperation 注解,response字段去掉.

该字段作用:声明指定返回值对象

swagger 返回值描述

 

修改后:

swagger 返回值描述

 

2.     将返回对象进行泛型声明

声明后swagger(丝袜哥) 会反射生成对象字段描述

 swagger 返回值描述

3.     使用 @ApiModelPropety 注解写明字段含义

@ApiModelProperty("XXX")

 

示例:


 swagger 返回值描述

1.1.2.  返回字段(单字段)

对于单字段及5个字段以内,可以用此方式说明返回值

 

swagger 返回值描述

 

 

1.2.      请求字段

1.2.1.  请求字段(对象)

接口入参声明为对象接收


 swagger 返回值描述

对象字段用 @ApiParam 注解进行标注


 swagger 返回值描述

1.2.2.  请求字段(单字段或多字段)

单字段或多字段用 @ApiImplicitParams @ApiImplicitParam 进行标注

swagger 返回值描述

向AI问一下细节

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

AI