Khi enable API versioning sử dụng Spring Framework 7 trở lên, ngoài việc định nghĩa default version cho những endpoint chưa được định nghĩa version, các bạn còn có thể định nghĩa danh sách các version được support bởi API của các bạn bằng cách sử dụng phương thức addSupportedVersions() khi cấu hình cho API versioning như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
package com.huongdanjava.springboot; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.ApiVersionConfigurer; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Configuration public class WebConfig implements WebMvcConfigurer { @Override public void configureApiVersioning(ApiVersionConfigurer configurer) { configurer.useRequestHeader("X-Api-Version") .addSupportedVersions("5.0.0", "1.0.2") .setDefaultVersion("1.0.0"); } } |
Khi sử dụng phương thức addSupportedVersions() này, thì ngoài những version đã được định nghĩa specific cho một số endpoint, API của chúng ta cũng sẽ support cho những version được khai báo trong phương thức addSupportedVersions().
Những version được định nghĩa trong phương thức addSupportedVersions() sẽ được tự động gán cho những endpoint không định nghĩa version hoặc những endpoint được định nghĩa với baseline version sử dụng dấu “+” ở cuối của giá trị version, như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
package com.huongdanjava.springboot; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class HelloController { @GetMapping("/hello") public String hello() { return """ { "message": "Hello from Huong Dan Java!" } """; } @GetMapping(value = "/hello", version = "1.1.0") public String hello1_1_0() { return """ { "message": "Hello from Huong Dan Java! V1.1.0" } """; } @GetMapping(value = "/hello", version = "1.2.0+") public String hello1_2_0() { return """ { "message": "Hello from Huong Dan Java! V1.2.0+" } """; } } |
Những version được support bởi API của mình, lớn hơn baseline version này, sẽ được handle bởi phương thức hello1_2_0() đó các bạn!
Cho ví dụ trên của mình, default version sẽ là 1.0.0, supported version là 5.0.0 và 1.0.2, specific version là 1.1.0 và 1.2.0. API của mình sẽ có thể handle các version sau cho endpoint “/hello”: 1.0.0, 1.0.2, 1.1.0, 1.2.0 và 5.0.0.
Theo thứ tự tăng dần của version thì các version 1.0.0 và 1.0.2 sẽ được handle bởi phương thức hello() đó các bạn! Nếu các bạn request với version 1.0.0 và 1.0.2 thì sẽ thấy kết quả như mình như sau:
và:
Version 1.1.0 sẽ được handle bởi phương thức hello_1_1_0():
Và version 1.2.0, 5.0.0 sẽ được handle bởi phương thức hello1_2_0():
Nếu mình remove support version 5.0.0 ở trên đi:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
package com.huongdanjava.springboot; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.ApiVersionConfigurer; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Configuration public class WebConfig implements WebMvcConfigurer { @Override public void configureApiVersioning(ApiVersionConfigurer configurer) { configurer.useRequestHeader("X-Api-Version") .addSupportedVersions("1.0.2") .setDefaultVersion("1.0.0"); } } |
rồi request lại endpoint “/hello” với version 5.0.0 thì các bạn sẽ thấy API của chúng ta không còn hỗ trợ cho version 5.0.0 nữa:
