Swagger使用说明

使用说明

1、类、方法、参数、返回值上的注解必填

--好处：前端可以识别参数名称

2、@Api上的tag 默认值为：类名；@ApiOperation 的tag默认值为版本号

--好处：tag会自动归类，前端很容易看出当前版本的方法

 

注意：类、方法、参数上的javadoc注释可以不写了

示例

类

方法

参数

返回值

Swagger 常用注解说明

注解	属性	备注	示例
@Api	value	可用在class头上,class描述	@Api(value = "xxx", description = "xxx")
	description
@ApiOperation	value	可用在方法头上.参数的描述容器	@ApiOperation(value = "xxx", notes = "xxx", method = "GET")
	notes	说明
	httpMethod	请求方法
@ApiImplicitParams	{}	可用在方法头上.参数的描述容器	@ApiImplicitParams({@ApiImplicitParam1,@ApiImplicitParam2,...})
@ApiImplicitParam	name	可用在@ApiImplicitParams里	@ApiImplicitParam(name = "newProduct", value = "商品信息对象", required = true, dataType = "Product", dataTypeClass = Product.class)
	value	参数中文描述
	required	true/false
	dataType	参数类型
	paramType	参数请求方式:query/path query:对应@RequestParam传递 path: 对应@PathVariable{}path传递
	dataType	参数类型
	dataTypeClass	参数对应的类
	defaultValue	在api测试中默认值
@ApiResponses	{}	可用在方法头上.参数的描述容器	@ApiResponses({@ApiResponse1,@ApiResponse2,...})
@ApiResponse	code	可用在@ApiResponses里	@ApiResponse(code = 200, message = "Successful", response = CommonResponse.class)
	message	错误描述
	response	返回结果对应的类
@ApiModelProperty	name	实体类参数名称	@ApiModelProperty(name = "name", value = "name", notes = "名称")
	value	实体类参数值
	notes	说明