swagger接口规范说明

1.1 class上添加注解@ApiModel

1.2 属性上添加注解@ApiModelProperty(value = \"姓名\，属性是属于对象关联属性则不需要添加example。 事例：

2. controller中添加注解

2.1 class上添加注解@Api(description = \" swagger事例\")。Description可以描述这个controller是用来做什么的，@ApiIgnore：在class上是过滤掉这个controller不让这个类下面的接口在前端显示，在方法上让这个接口不在前端显示

@RequestMapping(value = \"/testObject\ Method统一为RequestMethod.POST 2.2 方法上添加注解

2.2.1 @ApiOperation(value = \"test\= \"test\= \"application/json\")

说明：

value：方法名 notes:方法描述

produces：相应格式（统一为application/json） 2.2.2 @ApiImplicitParams({

@ApiImplicitParam(name = \"subcategoryId\年级iD\

true, paramType = \"query\

}) 说明：参数传入每一个@ApiImplicitParam表示一个参数

name:参数名，通过request.getParameter(\"name\").的名字 value:说明

required：是否必填，true:必填，false：不必填 paramType：参数获取类型（统一使用query） dataType：数据类型

事例：

如果没有返回数据对象，只需返回ResultObject

3. 访问swaggerUI，通过在工程访问路径后加上swagger-ui.html