Spring Boot REST API Versioning Example

I created this repository as I needed a simple playground to explore and test which versioning practice I thought was the best when working with Spring Boot.

Conclusion

I have concluded that I prefer using the HTTP Content negotiation headers (Content-Type and Accept) with custom MIME types to manage versioning. It follows the HTTP specification and is generally supported by out of the box by most web frameworks. Also, because it is part of the HTTP specification it already has a formal protocol defined around communicating incorrect versioning requests, etc. via well defined status codes.

• has formal protocol defined around communicating incorrect requests
  • Accept Header
  • Content-Type Header
  • 415 - Unsupported Media Type
  • 406 - Not Acceptable
• independently version endpoints without having to proxy unchanged endpoints
• generally handled by most web frameworks and clients

Run

mvn spring-boot:run

Testing References

Concepts

• https://agilewarrior.wordpress.com/2015/04/18/classical-vs-mockist-testing/
• https://martinfowler.com/articles/mocksArentStubs.html
• https://www.thoughtworks.com/insights/blog/mockists-are-dead-long-live-classicists

Tools

• https://joel-costigliola.github.io/assertj/
• http://site.mockito.org

Tactics

• https://spring.io/guides/gs/testing-web/
• https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-testing.html
• http://www.baeldung.com/spring-boot-testresttemplate
• https://dzone.com/articles/unit-and-integration-tests-in-spring-boot
• http://www.baeldung.com/spring-boot-testing