今天被前端训了一顿,慌得一逼,说你们写的接口,返回值写的是什么东西,只有公共的三个字段......
我们的API文档是基于 swagger 组件写的.如是有了下面的东东
示例:
1. 将现有接口 @ApiOperation 注解,response字段去掉.
该字段作用:声明指定返回值对象
修改后:
2. 将返回对象进行泛型声明
声明后swagger(丝袜哥) 会反射生成对象字段描述
3. 使用 @ApiModelPropety 注解写明字段含义
@ApiModelProperty("XXX")
示例:
对于单字段及5个字段以内,可以用此方式说明返回值
接口入参声明为对象接收
对象字段用 @ApiParam 注解进行标注
单字段或多字段用 @ApiImplicitParams @ApiImplicitParam 进行标注
免责声明：本站发布的内容（图片、视频和文字）以原创、转载和分享为主，文章观点不代表本网站立场，如果涉及侵权请联系站长邮箱：is@yisu.com进行举报，并提供相关证据，一经查实，将立刻删除涉嫌侵权内容。
