转自:https://swagger.io/docs/specification/describing-parameters/
Parameter Types
OpenAPI 3.0 distinguishes between the following parameter types based on the parameter location. The location is determined by the parameter’s in
key, for example, in: query
or in: path
.
- path parameters, such as
/users/{id}
- query parameters, such as
/users?role=admin
- header parameters, such as
X-MyHeader: Value
- cookie parameters, which are passed in the
Cookie
header, such asCookie: debug=0; csrftoken=BUSe35dohU3O1MZvDCU
例如:
@ApiOperation(value = "测试借口3", notes = "测试借口3", httpMethod = "GET", produces = MediaType.APPLICATION_JSON_VALUE)
@RequestMapping(value = "test3", method = RequestMethod.GET)
@ResponseBody
public ResultResponse<String> test3(
@ApiParam(value="颜色") @RequestParam String color
// @ApiParam(value="形状") @Param("shape") String shapeStr
){
// System.out.println(123121);
// return ResultResponse.success("testResult: " + color + "," + shapeStr);
return ResultResponse.success("testResult: " + color + ",");
}