注释类型 ApiVersion


  • @Documented
    @Retention(RUNTIME)
    @Target({TYPE,METHOD})
    public @interface ApiVersion
    RESTful API接口版本定义

    为接口提供优雅的版本路径,效果如下:

    @ApiVersion(1)

    @RequestMapping("/{version}/user")

    实际请求路径值:/v1/user
    从以下版本开始:
    2020年2月24日
    作者:
    ylyue
    • 可选元素概要

      可选元素 
      修饰符和类型 可选元素 说明
      boolean deprecated
      是否废弃版本接口
      double value
      RESTful API接口版本号
    • 元素详细资料

      • value

        double value
        RESTful API接口版本号

        最近优先原则:在方法上的 ApiVersion 可覆盖在类上面的 ApiVersion,如下:

        类上面的 value() 值 = 1.1,

        方法上面的 value() 值 = 2.1,

        最终效果:v2.1

        默认值:
        1.0
      • deprecated

        boolean deprecated
        是否废弃版本接口

        客户端请求废弃版本接口时将抛出错误提示:

        当前版本已停用,请升级到最新版本

        默认值:
        false