How to manage REST API versioning with spring?

by

Regardless whether versioning can be avoided by doing backwards compatible changes (which might not always possible when you are bound by some corporate guidelines or your API clients are implemented in a buggy way and would break even if they should not) the abstracted requirement is an interesting one:

How can I do a custom request mapping that does arbitrary evaluations of header values from the request without doing the evaluation in the method body?

As described in this SO answer you actually can have the same @RequestMapping and use a different annotation to differentiate during the actual routing that happens during runtime. To do so, you will have to:

  1. Create a new annotation VersionRange.
  2. Implement a RequestCondition<VersionRange>. Since you will have something like a best-match algorithm you will have to check whether methods annotated with other VersionRange values provide a better match for the current request.
  3. Implement a VersionRangeRequestMappingHandlerMapping based on the annotation and request condition (as described in the post How to implement @RequestMapping custom properties
    ).
  4. Configure spring to evaluate your VersionRangeRequestMappingHandlerMapping before using the default RequestMappingHandlerMapping (e.g. by setting its order to 0).

This wouldn’t require any hacky replacements of Spring components but uses the Spring configuration and extension mechanisms so it should work even if you update your Spring version (as long as the new version supports these mechanisms).

More Related Contents:

  1. Spring MVC @PathVariable getting truncated
  2. Using GZIP compression with Spring Boot/MVC/JavaConfig with RESTful
  3. Spring MVC – How to return simple String as JSON in Rest Controller
  4. How does the Spring @ResponseBody annotation work?
  5. How to set base url for rest in spring boot?
  6. Http Post request with content type application/x-www-form-urlencoded not working in Spring
  7. RESTful Authentication via Spring
  8. Spring MVC – @Valid on list of beans in REST service
  9. Expose all IDs when using Spring Data Rest
  10. Unable to get a generic ResponseEntity where T is a generic class “SomeClass”
  11. Spring REST security – Secure different URLs differently
  12. Trying to create REST-ful URLs with multiple dots in the “filename” part – Spring 3.0 MVC
  13. Spring MVC PATCH method: partial updates
  14. When using Spring Security, what is the proper way to obtain current username (i.e. SecurityContext) information in a bean?
  15. Difference between spring @Controller and @RestController annotation
  16. POST request via RestTemplate in JSON
  17. Return generated pdf using spring MVC
  18. Spring configure @ResponseBody JSON format
  19. Spring – No EntityManager with actual transaction available for current thread – cannot reliably process ‘persist’ call
  20. INFO: No Spring WebApplicationInitializer types detected on classpath
  21. Are Spring MVC Controllers Singletons?
  22. How to find all controllers in Spring MVC?
  23. Spring : File Upload RESTFUL Web Service
  24. Change database schema during runtime based on logged in user
  25. spring web, security + web.xml + mvc dispatcher + Bean is created twice
  26. Form submit in Spring MVC 3 – explanation
  27. Spring RequestMapping for controllers that produce and consume JSON
  28. Spring MVC – Binding a Date Field
  29. ExceptionHandler doesn’t work with Throwable
  30. java.lang.ClassNotFoundException: org.springframework.web.servlet.DispatcherServlet error

Leave a Comment