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;
   }
}

Dimitri Mestdagh · Accepted Answer · 2016-06-09 06:34:34Z

95

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 9, 2016 at 6:34

Dimitri Mestdagh

45.2k17 gold badges111 silver badges148 bronze badges

answered Jun 9, 2016 at 6:30

Deepak

1,7161 gold badge15 silver badges16 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

NRA Over a year ago

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.

Andrew Farrell Over a year ago

Where is HttpServletRequest imported from?

Deepak Over a year ago

javax.servlet.http.HttpServletRequest

TheRealChx101 Over a year ago

This does not include parameters

mohamnag · Accepted Answer · 2024-03-13 13:18:00Z

38

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.servlet.support.ServletUriComponentsBuilder;

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

edited Mar 13, 2024 at 13:18

answered Jun 7, 2018 at 6:18

mohamnag

2,9125 gold badges30 silver badges42 bronze badges

1 Comment

stemadsen Over a year ago

Cleanest solution. Can also be used outside of a Controller.

Cyva · Accepted Answer · 2017-08-17 09:26:18Z

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, 2017 at 9:26

Cyva

1,13710 silver badges10 bronze badges

2 Comments

SeverityOne Over a year ago

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.

TheRealChx101 Over a year ago

Where does this go? How?

chrylis -cautiouslyoptimistic- · Accepted Answer · 2019-03-13 17:54:45Z

5

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, 2019 at 17:54

chrylis -cautiouslyoptimistic-

77.5k21 gold badges127 silver badges167 bronze badges

1 Comment

Frans Over a year ago

I'd never heard of MvcUriComponentsBuilder before! It's so useful for RESTful controllers!

Collectives™ on Stack Overflow

How to get request URL in Spring Boot RestController

4 Answers 4

4 Comments

1 Comment

2 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

4 Comments

1 Comment

2 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related