How do I retrieve query parameters in Spring Boot

Question

I am developing a project using Spring Boot  I ve a controller which accepts GET requests   Currently I m accepting requests to the following kind of URLs      http   localhost 8888 user data 002   but I want to accept requests using query parameters      http   localhost 8888 user data 002   Here s the code of my controller    RequestMapping value   data  itemid    method   RequestMethod GET  public  ResponseBody item getitem  PathVariable  itemid   String itemid           item i   itemDao findOne itemid                     String itemname   i getItemname        String price   i getPrice        return i

User · Answer

I was interested in this as well and came across some examples on the Spring Boot site.

   // get with query string parameters e.g. /system/resource?id="rtze1cd2"&person="sam smith" 
// so below the first query parameter id is the variable and name is the variable
// id is shown below as a RequestParam
    @GetMapping("/system/resource")
    // this is for swagger docs
    @ApiOperation(value = "Get the resource identified by id and person")
    ResponseEntity<?> getSomeResourceWithParameters(@RequestParam String id, @RequestParam("person") String name) {

        InterestingResource resource = getMyInterestingResourc(id, name);
        logger.info("Request to get an id of "+id+" with a name of person: "+name);

        return new ResponseEntity<Object>(resource, HttpStatus.OK);
    }

See here also

User · Answer

To accept both  PathVariable and  RequestParam in the same  user endpoint   GetMapping path     quot  user quot    quot  user  data  quot    public void user  PathVariable required false name  quot data quot   String data                    RequestParam required false  Map lt String String gt  qparams        qparams forEach  a b  - gt            System out println String format  quot  s - gt   s quot  a b                 if  data    null            System out println data            Testing with curl   curl  http   localhost 8080 user books  curl  http   localhost 8080 user book ofdreams amp name nietzsche

User · Answer

In Spring boot  2 1 6  you can use like below       GetMapping  quot  orders quot        ApiOperation value    quot retrieve orders quot   response   OrderResponse class  responseContainer    quot List quot       public List lt OrderResponse gt  getOrders               RequestParam value    quot creationDateTimeFrom quot   required   true  String creationDateTimeFrom               RequestParam value    quot creationDateTimeTo quot   required   true  String creationDateTimeTo               RequestParam value    quot location id quot   required   true  String location id                TODO             return response    ApiOperation is an annotation that comes from Swagger api  It is used for documenting the apis

User · Answer

While the accepted answer by afraisse is absolutely correct in terms of using  RequestParam  I would further suggest to use an Optional lt   as you cannot always ensure the right parameter is used  Also  if you need an Integer or Long just use that data type to avoid casting types later on in the DAO    RequestMapping value   data   method   RequestMethod GET  public  ResponseBody Item getItem  RequestParam  itemid   Optional lt Integer gt  itemid         if  itemid isPresent              Item i   itemDao findOne itemid get                            return i         else

User · Answer

Use  RequestParam      RequestMapping value  user   method   RequestMethod GET  public  ResponseBody Item getItem  RequestParam  data   String itemid        Item i   itemDao findOne itemid                     String itemName   i getItemName        String price   i getPrice        return i

[java] How do I retrieve query parameters in Spring Boot?

Examples related to java

Examples related to rest

Examples related to spring-boot