1. 程式人生 > 其它 >SpringBoot中對不同請求引數的定義

SpringBoot中對不同請求引數的定義

GET:

case1:變數作為URL中的path的一部分: @PathVariable  路徑變數   get

例如:

http://172.17.2.165:32000/ac/orchestration/sd-wan/cpe/ha/3 

@ApiOperation(value = "查詢CPE高可用組詳情", notes = "查詢CPE高可用組詳情")
@ApiImplicitParam(name = "id", value = "高可用組ID", required = true, dataType = "long", example = "1")
@GetMapping("/cpe/ha/{id}")
public Result<QueryCpeHaVO> queryCpeHaById(@PathVariable("id") Long id) throws Exception {
QueryCpeHaVO query = sdDeviceService.queryCpeHaById(id);
return HttpResult.buildSuccessResult(query);
}

case2:變數作為URL中的引數   @RequestParam   請求引數

@ApiOperation(value = "獲取CPE高可用列表", notes = "獲取CPE高可用列表")
@ApiImplicitParams({
@ApiImplicitParam(name = "pageNum", value = "頁碼", dataType = "Integer"),
@ApiImplicitParam(name = "pageSize", value = "頁面大小", dataType = "Integer"),
@ApiImplicitParam(name = "name", value = "高可用組名稱"),
@ApiImplicitParam(name = "member", value = "成員")
})
@GetMapping(value = "/cpe/ha", produces = "application/json;charset=UTF-8")
public Result<SearchCpeHaListVO> getCpeHaList(@RequestParam(required = false, defaultValue = "1") Integer pageNum,
@RequestParam(required = false, defaultValue = "100000") Integer pageSize,
@RequestParam(required = false) String name,
@RequestParam(required = false) String member) {
CpeHaSearchCondition condition = CpeHaSearchCondition.builder().pageNum(pageNum).pageSize(pageSize)
.name(name).member(member)
.build();
SearchCpeHaListVO response = sdDeviceService.getCpeHaList(condition);
return HttpResult.buildSuccessResult(response);
}

POST: @
RequestBody 請求體 createorset
@ApiOperation(value = "新增CPE高可用組", notes = "新增CPE高可用組")
@PostMapping(value = "/cpe/ha", produces = "application/json;charset=UTF-8")
public Result addCpeHa(@RequestBody @Valid AddCpeHaVO addCpeHa, BindingResult bindingResult) throws Exception {
if (bindingResult.hasErrors()) {
FieldError fieldError = bindingResult.getFieldError();
log.error(fieldError.getDefaultMessage());
throw new CheckException(fieldError.getDefaultMessage());
}
sdDeviceService.addCpeHa(addCpeHa);
return HttpResult.buildSuccessResult(null);
}

PUT: update更新 @RequestBody 請求體

@ApiOperation(value = "編輯CPE高可用組", notes = "編輯CPE高可用組")
@PutMapping(value = "/cpe/ha", produces = "application/json;charset=UTF-8")
public Result editCpeHa(@RequestBody @Valid EditCpeHaVO editCpeHa, BindingResult bindingResult) throws Exception {
if (bindingResult.hasErrors()) {
FieldError fieldError = bindingResult.getFieldError();
log.error(fieldError.getDefaultMessage());
throw new CheckException(fieldError.getDefaultMessage());
}
sdDeviceService.editCpeHa(editCpeHa);
return HttpResult.buildSuccessResult(null);
}