How to get request URL in Spring Boot RestController

Question

I am trying to get the request URL in a RestController. The RestController has multiple methods annotated with @RequestMapping for different URIs and I am wondering how I can get the absolute URL from the @RequestMapping annotations.

@RestController
@RequestMapping(value = "/my/absolute/url/{urlid}/tests"
public class Test {
   @ResponseBody
   @RequestMapping(value "/",produces = "application/json")
   public String getURLValue(){
      //get URL value here which should be in this case, for instance if urlid      
       //is 1 in request then  "/my/absolute/url/1/tests"
      String test = getURL ?
      return test;
   }
}

score 90 · Answer 1 · edited Jun 09 '16 at 06:34

90

You may try adding an additional argument of type HttpServletRequest to the getUrlValue() method:

@RequestMapping(value ="/",produces = "application/json")
public String getURLValue(HttpServletRequest request){
    String test = request.getRequestURI();
    return test;
}

edited Jun 09 '16 at 06:34

g00glen00b

41,995
13
95
133

answered Jun 09 '16 at 06:30

Deepak

1,506
1
14
13

Thanks for reply and example. I know this method but was wondering if there is way to get url info using any properties in controller level but seems like this is the correct way. – NRA Jun 12 '16 at 20:29
Where is HttpServletRequest imported from? – Andrew Farrell Sep 30 '16 at 14:04
2

javax.servlet.http.HttpServletRequest – Deepak Sep 30 '16 at 14:22
This does not include parameters – TheRealChx101 Sep 11 '21 at 01:40

score 35 · Answer 2 · answered Jun 07 '18 at 06:18

If you don't want any dependency on Spring's HATEOAS or javax.* namespace, use ServletUriComponentsBuilder to get URI of current request:

import org.springframework.web.util.UriComponentsBuilder;

ServletUriComponentsBuilder.fromCurrentRequest();
ServletUriComponentsBuilder.fromCurrentRequestUri();

score 9 · Answer 3 · answered Aug 17 '17 at 09:26

9

Allows getting any URL on your system, not just a current one.

import org.springframework.hateoas.mvc.ControllerLinkBuilder
...
ControllerLinkBuilder linkBuilder = ControllerLinkBuilder.linkTo(methodOn(YourController.class).getSomeEntityMethod(parameterId, parameterTwoId))

URI methodUri = linkBuilder.Uri()
String methodUrl = methodUri.getPath()

answered Aug 17 '17 at 09:26

Cyva

1,057
10
9

This answer works perfectly, but is it possible to do without having a HATEAOS dependency? Although all the methods I tried depend on the request, one way or another, and I don't have that in my scenario. – SeverityOne Jun 25 '20 at 12:55
Where does this go? How? – TheRealChx101 Sep 11 '21 at 01:40

score 4 · Answer 4 · answered Mar 13 '19 at 17:54

4

Add a parameter of type UriComponentsBuilder to your controller method. Spring will give you an instance that's preconfigured with the URI for the current request, and you can then customize it (such as by using MvcUriComponentsBuilder.relativeTo to point at a different controller using the same prefix).

answered Mar 13 '19 at 17:54

chrylis -cautiouslyoptimistic-

75,269
21
115
152

2

I'd never heard of `MvcUriComponentsBuilder` before! It's so useful for RESTful controllers! – Frans Mar 11 '20 at 14:57

How to get request URL in Spring Boot RestController

4 Answers4

Linked