介绍

  • 产品的迭代有时候会遇到接口需要版本，于是就有了这个需求
  • 微侵入使用
  • 参考与感谢

    引入依赖

    1. <dependency>
    2. <groupId>cn.jdevelops</groupId>
    3. <artifactId>aops-apiversion</artifactId>
    4. <version>2.0.2</version>
    5. </dependency>

    使用

    • 注解形式无需额外配置
    • 默认返回1.0的接口
    • 参数名：version


版本 跟在 header中

  1. package io.tn.aop.version.controller;
  3. import com.detabes.version.annotation.ApiVersion;
  4. import org.springframework.web.bind.annotation.GetMapping;
  5. import org.springframework.web.bind.annotation.RestController;
  7. /**
  8.  * 版本
  9.  *
  10.  * @author tn
  11.  * @version 1
  12.  * @date 2021/1/30 21:53
  13.  */
  14. @RestController
  15. public class VersionController {
  17.     /*********         header                     *******/
  18.     @GetMapping("/api/test_2")
  19.     @ApiVersion(1.0)
  20.     public String version1_2() {
  21.         return "Hello,Welcome to version 1.0 header";
  22.     }
  24.     @GetMapping("/api/test_2")
  25.     @ApiVersion(2.0)
  26.     public String version2_2() {
  27.         return "Hello,Welcome to version 2.0 header";
  28.     }
  30.     @GetMapping("/api/test_2")
  31.     @ApiVersion(3.0)
  32.     public String version3_2() {
  33.         return "Hello,Welcome to version 3.0 header";
  34.     }
  35.     /*********         parameter                     *******/
  36. }

版本 跟在 参数中

  1. package io.tn.aop.version.controller;
  3. import com.detabes.version.annotation.ApiVersion;
  4. import org.springframework.web.bind.annotation.GetMapping;
  5. import org.springframework.web.bind.annotation.RestController;
  7. /**
  8.  * 版本
  9.  *
  10.  * @author tn
  11.  * @version 1
  12.  * @date 2021/1/30 21:53
  13.  */
  14. @RestController
  15. public class VersionController {
  18.     /*********         parameter                     *******/
  19.     @GetMapping("/api/test_1")
  20.     @ApiVersion(1.0)
  21.     public String version1_1(String version) {
  22.         return "Hello,Welcome to version 1.0 parameter";
  23.     }
  25.     @GetMapping("/api/test_1")
  26.     @ApiVersion(2.0)
  27.     public String version2_1(String version) {
  28.         return "Hello,Welcome to version 2.0 parameter";
  29.     }
  31.     @GetMapping("/api/test_1")
  32.     @ApiVersion(3.0)
  33.     public String version3_1(String version) {
  34.         return "Hello,Welcome to version 3.0 parameter";
  35.     }
  36.     /*********         parameter                     *******/
  39. }

版本 跟在 url 中

这种方式我给删除了。觉得验证的不是很安全


示例项目地址

https://github.com/en-o/Jdevelops-Example/tree/main/ApiVersion