spring-api-versioning

Simple development of multi-version api based on spring-mvc via @ApiVersion annotation, support for uri, header, param.

License	The Apache License, Version 2.0
GroupId	com.github.lkqm
ArtifactId	spring-api-versioning
Last Version	1.3.0
Release Date	Apr 29, 2021
Type	jar
Description	spring-api-versioning Simple development of multi-version api based on spring-mvc via @ApiVersion annotation, support for uri, header, param.
Project URL	https://github.com/lkqm/spring-api-versioning
Source Code Management	https://github.com/lkqm/spring-api-versioning

Download spring-api-versioning

Filename	Size
spring-api-versioning-1.3.0.pom
spring-api-versioning-1.3.0.jar	14 KB
spring-api-versioning-1.3.0-sources.jar	6 KB
spring-api-versioning-1.3.0-javadoc.jar	62 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.github.lkqm/spring-api-versioning/ -->
<dependency>
    <groupId>com.github.lkqm</groupId>
    <artifactId>spring-api-versioning</artifactId>
    <version>1.3.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.github.lkqm/spring-api-versioning/
implementation 'com.github.lkqm:spring-api-versioning:1.3.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.github.lkqm/spring-api-versioning/
implementation ("com.github.lkqm:spring-api-versioning:1.3.0")

Apache Buildr

'com.github.lkqm:spring-api-versioning:jar:1.3.0'

Apache Ivy

<dependency org="com.github.lkqm" name="spring-api-versioning" rev="1.3.0">
  <artifact name="spring-api-versioning" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.github.lkqm', module='spring-api-versioning', version='1.3.0')
)

Scala SBT

libraryDependencies += "com.github.lkqm" % "spring-api-versioning" % "1.3.0"

Leiningen

[com.github.lkqm/spring-api-versioning "1.3.0"]

Dependencies

compile (3)

Group / Artifact	Type	Version
org.springframework.boot : spring-boot-starter Optional	jar	2.3.9.RELEASE
org.springframework.boot : spring-boot-configuration-processor Optional	jar	2.3.9.RELEASE
org.springframework.boot : spring-boot-starter-web Optional	jar	2.3.9.RELEASE

provided (1)

Group / Artifact	Type	Version
org.projectlombok : lombok	jar	1.18.8

test (1)

Group / Artifact	Type	Version
org.springframework.boot : spring-boot-starter-test	jar	2.3.9.RELEASE

Project Modules

There are no modules declared in this project.

spring-api-versioning

Simple development of multi-version api based on spring-mvc via @ApiVersion annotation, support for uri, header, param.

Supports: JDK 1.8, spring-boot 2.x

Features

• URI: /v1/user/list, /v2/user/list
• Header: /user/list, header: X-API-VERSION=1
• Param: /user/list?api_version=1

Important: version number use precise matching with String equals method.

Quick

1. Add Dependency(Maven)

   <dependency>
      <groupId>com.github.lkqm</groupId>
      <artifactId>spring-api-versioning</artifactId>
      <version>${version}</version>
   </dependency>
   

2. @EnableApiVersioning with Application class

   @SpringBootApplication
   @EnableApiVersioning
   public class Application {
       public static void main(String[] args) {
           SpringApplication.run(Application.class, args);
       }
   }
   

3. Controller

   @RestController
   @RequestMapping("/user")
   @ApiVersion("1")
   public class UserController {
   
       @GetMapping("/list")
       public String list1() {
           return "list1";
       }
   
       @GetMapping("/list")
       @ApiVersion("1.1")
       public String list2() {
           return "list2";
       }
   }
   

4. Test

   curl http://127.0.0.1:8080/v1/user/list
   curl http://127.0.0.1:8080/v1.1/user/list
   

Config properties

api.version.type=uri                # versioning implement way: uri(default), header, param
api.version.uri-prefix=             # uri prefix, if set /api, request uri like: /api/v1/... /api/v2/...
api.version.uri-location=           # uri version location: begin(/v1/user/list), end(/user/list/v1)
api.version.header=X-API-VERSION    # version control http header name
api.version.param=api_version       # version control http query string name

Versions

Version
1.3.0 Apr 29, 2021
1.2.0 May 26, 2020
1.1.0 May 25, 2020
1.0.0 Nov 24, 2019