I have spring code where there is request as follows :
#RequestMapping(method = RequestMethod.GET, value = {
EnterpriseLiterals.ROOT_URL_SIMPLE + "storeDepartments/search.json",
EnterpriseLiterals.ROOT_URL_SIMPLE + "storeDepartments/search" },params = { "!dealerStoreId" })
public Map<String, List<? extends AbstractDepartment>> getDepartments(
#RequestParam(value = "enterpriseId", required = true) String enterpriseId,#RequestParam(value = "responseFields", required = false) String responseFields)
And another request as :
#RequestMapping(method = RequestMethod.GET, value = {
EnterpriseLiterals.ROOT_URL_SIMPLE + "storeDepartments/search",
EnterpriseLiterals.ROOT_URL_SIMPLE + "storeDepartments/search.json" },params = {"!enterpriseId"})
#ResponseBody
public Map<String, List<AbstractDepartment>> getDepartmentListBasedOnStoreAndDeptType(#RequestParam(value = "dealerStoreId", required = true) String dealerStoreId,#RequestParam(value = "responseFields", required = false, defaultValue = "summary") String responseFields)
However, since there is responseFields in both the requests I am getting error when I call the above API's with responseFields saying "ResponseFields does not exist.".
Please help with solutions to solve this problem.
Related
I am generating the swagger docs for my REST API using SpringFox.
I have added an optional parameter to my API now:
#ApiOperation(
value = "Get all cars"
)
#GetMapping(value = "/cars", produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<ResponseDTO<CarDTO>> getCars(
#RequestParam(defaultValue = "1") Integer page,
#RequestParam(required = false) String status) {
ResponseDTO<CarDTO> response = service.getCars(page, status);
return ResponseEntity.ok(response);
}
How do I highlight in the swagger docs that one is required and the other is optional?
You have the #ApiParam annotation you can use, it has a property required which you can put to true or false depending on your needs
#ApiOperation(
value = "Get all cars"
)
#GetMapping(value = "/cars", produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<ResponseDTO<CarDTO>> getCars(
#ApiParam(required = true) #RequestParam(defaultValue = "1") Integer page,
#ApiParam(required = false) #RequestParam(required = false) String status) {
ResponseDTO<CarDTO> response = service.getCars(page, status);
return ResponseEntity.ok(response);
}
As you can see in the documentation, it has other properties like
access
allowableValues
allowMultiple
defaultValue
name
value
How do I use #RequestParam to bind one parameters of type String which is mandatory and another one which is of type Map<String, String> which is optional ?
#RequestMapping(value = "users", method = RequestMethod.GET)
public String getUsers(#RequestParam(name = "mandatory") String mandatory,
#RequestParam(required = false) Map < String, String > optional)
throws Exception {
return userService.getUsers(mandatory, optional);
}
If what you want is to simply indicate that the "mandatory" parameter is required, you must add the required = true as follows:
#RequestMapping(value = "users", method = RequestMethod.GET)
public String getUsers(#RequestParam(name = "mandatory", required = true) String mandatory,
#RequestParam(required = false) Map < String, String > optional)
throws Exception {
return userService.getUsers(mandatory, optional);
}
I'm new in Spring Boot and I want to have the same Request Mapping method for JSON and simple request params, for example:
#RequestMapping(value = "/start")
public String startPostProcess(#RequestParam(value = "url",
required = false,
defaultValue = "https://goo.gl") String url,
#RequestParam(value = "word",
required = false,
defaultValue = "Search") String word,
#RequestBody String hereGoesJSON) {
//Do some stuff
}
So, when request goes with params, only #RequestParam will work, in other cases we will use #RequestBody annotation.
localhost:8080/start?url=htts://google.com&word=Luck
Or may bee I'll be able to write method like this, for accepting any params:
#RequestMapping(value = "/start")
public String startPostProcess(#RequestBody String anyParam) {
//Parse this anyParam
}
?
I've not found this trick in spring documentation, so I will appreciate any links to it.
Okay, I've solved the problem :D
All that I just needed was 2 methods with the same mapping and explicitly specify RequestMethod type:
#RequestMapping(value = "/start")
public String startPostProcess(#RequestParam(value = "url",
required = false,
defaultValue = "https://goo.gl") String url,
#RequestParam(value = "word",
required = false,
defaultValue = "Search") String word) throws InterruptedException {
//Do some stuff
}
#RequestMapping(value = "/start", method = RequestMethod.POST, consumes = "application/json")
public String startJsonProcess(#RequestBody String body) {
//Do another stuff with RequestBody
}
UPD: added "consumes = "application/json". It helps dividing simple POST requests and JSON POST requests.
I have been trying to create a small java client to call Highchart Export server to get the pdf/jpeg etc.. but it is not successful using Spring's RestTemplate -> RestTemplate restTemplate = new org.springframework.web.client.RestTemplate() in the client side. I tried post/get/exchange methods.. but unable to PASS the required method parameters to the server side... the required method is getting called without the params and returnd their test jsp page.
Highchart Export Server code =>
#Controller
#RequestMapping("/")
public class ExportController extends HttpServlet {
...
...
#RequestMapping(method = {RequestMethod.POST, RequestMethod.GET})
public HttpEntity<byte[]> exporter(
#RequestParam(value = "svg", required = false) String svg,
#RequestParam(value = "type", required = false) String type,
#RequestParam(value = "filename", required = false) String filename,
#RequestParam(value = "width", required = false) String width,
#RequestParam(value = "scale", required = false) String scale,
#RequestParam(value = "options", required = false) String options,
#RequestParam(value = "globaloptions", required = false) String globalOptions,
#RequestParam(value = "constr", required = false) String constructor,
#RequestParam(value = "callback", required = false) String callback,
#RequestParam(value = "callbackHC", required = false) String callbackHC,
#RequestParam(value = "async", required = false, defaultValue = "false") Boolean async,
#RequestParam(value = "jsonp", required = false, defaultValue = "false") Boolean jsonp,
HttpServletRequest request,
HttpSession session) throws ServletException, InterruptedException, SVGConverterException, NoSuchElementException, PoolException, TimeoutException, IOException, ZeroRequestParameterException {
...
}
}
What method in RestTemplate should I call and how to pass the params from client side like JSON formatted options, type etc, so that above Service method gets executed with proper params? Your help is appreciated.
I made it work after passing values in org.springframework.util.LinkedMultiValueMap object like
MultiValueMap<String, String> prms = new LinkedMultiValueMap<String, String>();
prms.add("param1", "value1");
prms.add("param2", "value2");
and then calling..
RestTemplate restTemplate = new RestTemplate();
byte[] b = restTemplate.postForObject("http://****/", prms, byte[].class);
Facing issue while posting call to server side
Exception stack trace :
"org.springframework.web.bind.MissingServletRequestParameterException: Required int parameter 'answerId' is not present\r\n\tat org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter$ServletHandlerMethodInvoker.raiseMissingParameterException(AnnotationMethodHandlerAdapter.java:773)\r\n\tat org.springframework.web.bind.annotation.support.HandlerMethodInvoker.resolveRequestParam(HandlerMethodInvoker.java:509)
Javascript call in controller.js
$scope.saveCorrectAnswer = function(answerId) {
var answerIdVal = 0;
answerIdVal = answerId;
if(document.getElementById(answerId).className == 'ico-white-check') {
$scope.answer.correct = 'Y';
} else{
$scope.answer.correct = 'N';
}
Answer.update({answerId: answerIdVal, correct: $scope.answer.correct}, function(response) {
// On success go to Exchange
//$route.reload();
},
Mapping in service controller in java:
#RequestMapping(method = RequestMethod.PUT, consumes = "application/json", produces = "application/json")
#ResponseBody
public void addCorrectAnswer(#RequestParam int answerId, #RequestParam String correct) {
getAnswerDAC().addCorrectAnswer(answerId, correct);
}
#RequestParam has an attribute required which is true by default. If answerId is not required, change the annotation and parameter type as follows...
#RequestMapping(method = RequestMethod.PUT, consumes = "application/json", produces = "application/json")
#ResponseBody
public void addCorrectAnswer(#RequestParam(required = false) Integer answerId, #RequestParam String correct) {
getAnswerDAC().addCorrectAnswer(answerId, correct);
}
Edit: Since answerId is a primitive value in your example, you would also need to provide a defaultValue in the annotation. Providing a defaultValue implicitly sets required to false, so I'll leave it out of the example...
#RequestMapping(method = RequestMethod.PUT, consumes = "application/json", produces = "application/json")
#ResponseBody
public void addCorrectAnswer(#RequestParam(defaultValue = 0) int answerId, #RequestParam String correct) {
getAnswerDAC().addCorrectAnswer(answerId, correct);
}
Hope this helps