swagger接口规范说明

《swagger接口规范说明》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、1.bean对象中添加注解1.1class上添加注解@ApiModel1.2属性上添加注解@ApiModelProperty(value="姓名",example="name")，属性是属于对象关联属性则不需要添加example。事例：2.controller中添加注解2.1class上添加注解@Api(description="swagger事例")。Description可以描述这个controller是用来做什么的，@ApiIgnore：在class上是过滤掉这个controller不让这个类下面的接口在前端显示，在方法上让这个接口不在前

2、端显示@RequestMapping(value="/testObject",method=RequestMethod.POST)Method统一为RequestMethod.POST2.2方法上添加注解2.2.1@ApiOperation(value="test",notes="test",produces="application/json")说明：value：方法名notes:方法描述produces：相应格式（统一为application/json）2.2.2@ApiImplicitParams({@ApiImplicitParam(n

3、ame="subcategoryId",value="年级iD",required=true,paramType="query",dataType="string")})说明：参数传入每一个@ApiImplicitParam表示一个参数name:参数名，通过request.getParameter("name").的名字value:说明required：是否必填，true:必填，false：不必填paramType：参数获取类型（统一使用query）dataType：数据类型事例：如果没有返回数据对象，只需返回ResultObject1.访问s

4、waggerUI，通过在工程访问路径后加上swagger-ui.html