《swagger》 swagger + springboot 传递 对象参数, List,数组参数

Swagger是最受欢迎的REST APIs文档生成工具之一, 与springboot 的restful风格的api配合, 更是让你事半功倍.

传对象,传list或数组是常遇到的问题.

传递对象参数

	@ApiOperation(value="添加Client", notes="增加Client" )
	@ApiImplicitParam(name = "client", value = "client信息", required = true, dataType = "Client")
	@PutMapping("/save")
	public Client save(@RequestBody Client client) {
		return clientService.save(client);
	}

传递List参数

	@ApiOperation(value="添加权限", notes="增加权限" )
	@ApiImplicitParams({ 
        @ApiImplicitParam(name = "clientId", value = "客户端ID", required = true, paramType = "query",dataType = "String", defaultValue="1"),
      })
	@PutMapping("/save")
	public Boolean save(String clientId, @RequestParam(value = "powerClientIds") @ApiParam(value = "可被访问的clientId列表") List<String> powerClientIds) {
                ........
		return true;
	}

@ApiImplicitParam的详细介绍及使用示例：name（必需）：指定参数的名称。
value（可选）：对参数的简单描述。
dataType（必需）：指定参数的数据类型。
paramType（必需）：指定参数的类型，可以是path、query、body、header或form。
example（可选）：指定参数的示例值。
required（可选）：指定参数是否是必需的，默认为false。
defaultValue（可选）：指定参数的默认值。