RestTemplate How to send URL and query parameters together

Question

I am trying to pass path param and query params in a URL but I am getting a weird error  below is the code      String url    http   test com Services rest  id  Identifier      Map lt String  String gt  params   new HashMap lt String  String gt         params put  id    1234        UriComponentsBuilder builder   UriComponentsBuilder fromUriString url                                           queryParam  name    myName        String uriBuilder   builder build   encode   toUriString        restTemplate exchange uriBuilder   HttpMethod PUT  requestEntity                      class p  params     and my url is becoming http   test com Services rest  7Bid 7D Identifier name myName  what should I do to make it work  I am expecting http   test com Services rest  id  Identifier name myName so that params will add id to the url  please suggest  thanks in Advance

User · Answer

String url    quot http   test com Services rest  id  Identifier quot   Map lt String  String gt  params   new HashMap lt String  String gt     params put  quot id quot    quot 1234 quot    URI uri   UriComponentsBuilder fromUriString url           buildAndExpand params           toUri    uri   UriComponentsBuilder          fromUri uri           queryParam  quot name quot    quot myName quot            build            toUri    restTemplate exchange uri   HttpMethod PUT  requestEntity  class p     The safe way is to expand the path variables first  and then add the query parameters   For me this resulted in duplicated encoding  e g  a space was decoded to  2520  space - gt   20 - gt   25   I solved it by  String url    quot http   test com Services rest  id  Identifier quot   Map lt String  String gt  params   new HashMap lt String  String gt     params put  quot id quot    quot 1234 quot    UriComponentsBuilder uriComponentsBuilder   UriComponentsBuilder fromUriString url   uriComponentsBuilder uriVariables params   Uri uri   uriComponentsBuilder queryParam  quot name quot    quot myName quot             build            toUri    restTemplate exchange uri   HttpMethod PUT  requestEntity  class p    Essentially I am using uriComponentsBuilder uriVariables params   to add path parameters  The documentation says       In contrast to UriComponents expand Map  or buildAndExpand Map   this method is useful when you need to supply URI variables without building the UriComponents instance just yet  or perhaps pre-expand some shared default values such as host and port       Source  https   docs spring io spring-framework docs current javadoc-api org springframework web util UriComponentsBuilder html uriVariables-java util Map-

User · Answer

An issue with the answer from Michal Foksa is that it adds the query parameters first  and then expands the path variables  If query parameter contains parenthesis  e g   foobar   this will cause an exception   The safe way is to expand the path variables first  and then add the query parameters   String url    http   test com Services rest  id  Identifier   Map lt String  String gt  params   new HashMap lt String  String gt     params put  id    1234    URI uri   UriComponentsBuilder fromUriString url           buildAndExpand params           toUri    uri   UriComponentsBuilder          fromUri uri           queryParam  name    myName            build            toUri    restTemplate exchange uri   HttpMethod PUT  requestEntity  class p

User · Answer

One simple way to do that is  String url    quot http   test com Services rest  id  Identifier quot   UriComponents uriComponents   UriComponentsBuilder fromUriString url  build    uriComponents   uriComponents expand Collections singletonMap  quot id quot    quot 1234 quot      and then adds the query params

User · Answer

One-liner using TestRestTemplate exchange function with parameters map   restTemplate exchange   someUrl id  id    HttpMethod GET  reqEntity  respType    id   id     The params map initialized like this is a groovy initializer

User · Answer

I would use buildAndExpand from UriComponentsBuilder to pass all types of URI parameters    For example   String url    http   test com solarSystem planets  planet  moons  moon        URI  URL  parameters Map lt String  String gt  urlParams   new HashMap lt  gt     urlParams put  planets    Mars    urlParams put  moons    Phobos        Query parameters UriComponentsBuilder builder   UriComponentsBuilder fromUriString url             Add query parameter          queryParam  firstName    Mark            queryParam  lastName    Watney     System out println builder buildAndExpand urlParams  toUri            Console output     http   test com solarSystem planets Mars moons Phobos firstName Mark amp lastName Watney      restTemplate exchange builder buildAndExpand urlParams  toUri     HttpMethod PUT          requestEntity  class p           Log entry     org springframework web client RestTemplate Created PUT request for  http   test com solarSystem planets Mars moons Phobos firstName Mark amp lastName Watney

[java] RestTemplate: How to send URL and query parameters together

Examples related to java

Examples related to resttemplate

Examples related to url-parameters

Examples related to query-parameters

Examples related to path-parameter