Bug in Documentation: @RepositoryRestController is NOT exposed under base-path [DATAREST-1327]

[spring-projects-issues]

Doogiemuc opened DATAREST-1327 and commented

The spring-data-rest doc sais:

Controllers annotated with @RepositoryRestController are served from the API base path defined in RepositoryRestConfiguration.setBasePath, which is used by all other RESTful endpoints (for example, /api).

https://docs.spring.io/spring-data/rest/docs/current/reference/html/#customizing-sdr.overriding-sdr-response-handlers

This is not true.

@RepositoryRestController
public class MyCustomController {
  @RequestMapping(value = "/myCustomResource")
  public ResponseEntity<?> customResource() { ... }
}

is not mapped at all.

One MUST use a @RequestMapping on class level.  Even @RequestMapping("/")  works to map MyCustomController. See also https://stackoverflow.com/questions/38607421/spring-data-rest-controllers-behaviour-and-usage-of-basepathawarecontroller

There is a workaround:

@RepositoryRestController
@RequestMapping("${spring.data.rest.base-path}")
public class MyCustomController { ... }

At least update the documentation to describe this correctly

---

Reference URL: https://stackoverflow.com/questions/38607421/spring-data-rest-controllers-behaviour-and-usage-of-basepathawarecontroller

1 votes, 4 watchers

[spring-projects-issues]

jntesteves commented

I converted a system to SDR and didn't take notice of this part of documentation, so my properties don't include spring.data.rest.base-path=/api, but it still includes the old line server.servlet.contextPath=/api and that seems to be honored by SDR. I only have a @RepositoryRestController annotation on my controllers and they do override SDR's methods under /api.

But using, for example @RequestMapping("/users") in my UserController class seems to break SDR's endpoints for this entity in this setup, so I had to repeat @RequestMapping("/users") with this endpoint's base URI in every method. Not ideal. I'll want to fix my controllers when we reach a conclusion on this issue

[odrotbohm]

Duplicates #1342. See the my latest comment over there.