API Versioning examples integrated into spring-boot-mvc-5Api versioning clean

spring-boot-modules/pom.xml

@@ -25,7 +25,7 @@
         <module>spring-boot-annotations-2</module>
         <module>spring-boot-artifacts</module>
         <module>spring-boot-artifacts-2</module>
-        <module>spring-boot-autoconfiguration</module>
+	<module>spring-boot-autoconfiguration</module>
         <module>spring-boot-basic-customization</module>
         <module>spring-boot-basic-customization-2</module>
         <module>spring-boot-bootstrap</module>

spring-boot-modules/spring-boot-mvc-5/pom.xml

@@ -2,6 +2,7 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
     <modelVersion>4.0.0</modelVersion>
     <artifactId>spring-boot-mvc-5</artifactId>
     <name>spring-boot-mvc-5</name>
@@ -14,6 +15,22 @@
         <version>1.0.0-SNAPSHOT</version>
     </parent>
 
+    <properties>
+        <java.version>17</java.version>
+        <maven.compiler.source>17</maven.compiler.source>
+        <maven.compiler.target>17</maven.compiler.target>
+        <maven.compiler.release>17</maven.compiler.release>
+
+        <spring-boot.version>3.2.2</spring-boot.version>
+        <spring.fox.version>3.0.0</spring.fox.version>
+        <spring-cloud.version>2023.0.0</spring-cloud.version>
+        <commons-configuration.version>1.10</commons-configuration.version>
+        <rome.version>1.10.0</rome.version>
+
+        <!-- Set your correct main class -->
+        <start-class>com.baeldung.versioning.ApiVersioningDemoApplication</start-class>
+    </properties>
+
     <dependencyManagement>
         <dependencies>
             <dependency>
@@ -81,15 +98,4 @@
         </plugins>
     </build>
 
-    <properties>
-        <spring-boot.version>3.2.2</spring-boot.version>
-        <spring.fox.version>3.0.0</spring.fox.version>
-        <start-class>com.baeldung.springboot.swagger.ArticleApplication</start-class>
-        <spring-cloud.version>2023.0.0</spring-cloud.version>
-        <commons-configuration.version>1.10</commons-configuration.version>
-        <maven.compiler.release>17</maven.compiler.release>
-        <!-- ROME for RSS -->
-        <rome.version>1.10.0</rome.version>
-    </properties>
-
-</project>
+</project>

spring-boot-modules/spring-boot-mvc-5/src/main/java/com/baeldung/versioning/ApiVersioningDemoApplication.java

@@ -0,0 +1,11 @@
+package com.baeldung.versioning;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class ApiVersioningDemoApplication {
+    public static void main(String[] args) {
+        SpringApplication.run(ApiVersioningDemoApplication.class, args);
+    }
+}

spring-boot-modules/spring-boot-mvc-5/src/main/java/com/baeldung/versioning/controller/UserParamController.java

@@ -0,0 +1,27 @@
+package com.baeldung.versioning.controller;
+
+import com.baeldung.versioning.model.UserV2;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.util.List;
+
+@RestController
+public class UserParamController {
+
+@GetMapping("/api/users")
+public Object getUsers(@RequestParam(name = "version", defaultValue = "1") String version) {
+    if ("1".equals(version)) {
+        return List.of("Alice", "Bob");
+    } else if ("2".equals(version)) {
+        return List.of(
+            new UserV2("Alice", "[email protected]", 30),
+            new UserV2("Bob", "[email protected]", 25)
+        );
+    } else {
+        return "Unsupported API version";
+    }
+}
+
+}

spring-boot-modules/spring-boot-mvc-5/src/main/java/com/baeldung/versioning/controller/header/UserHeaderController.java

@@ -0,0 +1,27 @@
+// src/main/java/.../controller/header/UserHeaderController.java
+package com.baeldung.versioning.controller.header;
+
+import com.baeldung.versioning.model.UserV1;
+import com.baeldung.versioning.model.UserV2;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestHeader;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.util.List;
+
+@RestController
+public class UserHeaderController {
+
+    @GetMapping(value = "/api/users", headers = "X-API-VERSION=1")
+public List<UserV1> getUsersV1() {
+    return List.of(new UserV1("Alice"), new UserV1("Bob"));
+}
+
+@GetMapping(value = "/api/users", headers = "X-API-VERSION=2")
+public List<UserV2> getUsersV2() {
+    return List.of(
+        new UserV2("Alice", "[email protected]", 30),
+        new UserV2("Bob", "[email protected]", 25)
+    );
+}
+}

spring-boot-modules/spring-boot-mvc-5/src/main/java/com/baeldung/versioning/controller/mime/UserMimeController.java

@@ -0,0 +1,36 @@
+// src/main/java/com/baeldung/example/apiversioning/controller/mime/UserMimeController.java
+package com.baeldung.versioning.controller.mime;
+
+import com.baeldung.versioning.model.UserV1;
+import com.baeldung.versioning.model.UserV2;
+import org.springframework.http.MediaType;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.util.List;
+
+@RestController
+public class UserMimeController {
+
+    public static final String V1_MEDIA = "application/vnd.example.users-v1+json";
+    public static final String V2_MEDIA = "application/vnd.example.users-v2+json";
+
+    @GetMapping(value = "/api/users", produces = V1_MEDIA)
+    public List<UserV1> usersV1() {
+        return List.of(new UserV1("Alice"), new UserV1("Bob"));
+    }
+
+    @GetMapping(value = "/api/users", produces = V2_MEDIA)
+    public List<UserV2> usersV2() {
+        return List.of(
+            new UserV2("Alice", "[email protected]", 30),
+            new UserV2("Bob", "[email protected]", 25)
+        );
+    }
+
+    // Optional fallback
+    @GetMapping(value = "/api/users", produces = MediaType.APPLICATION_JSON_VALUE)
+    public List<UserV1> defaultUsers() {
+        return List.of(new UserV1("Alice"), new UserV1("Bob"));
+    }
+}

spring-boot-modules/spring-boot-mvc-5/src/main/java/com/baeldung/versioning/controller/negotiation/UserContentNegotiationController.java

@@ -0,0 +1,20 @@
+package com.baeldung.versioning.controller.negotiation;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/users")
+public class UserContentNegotiationController {
+
+    @GetMapping(value = "/negotiation", produces = "application/vnd.col.users.v1+json")
+    public String getUsersV1() {
+        return "User list v1";
+    }
+
+    @GetMapping(value = "/negotiation", produces = "application/vnd.col.users.v2+json")
+    public String getUsersV2() {
+        return "User list v2";
+    }
+}

spring-boot-modules/spring-boot-mvc-5/src/main/java/com/baeldung/versioning/controller/v1/UserV1Controller.java

@@ -0,0 +1,14 @@
+package com.baeldung.versioning.controller.v1;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/v1/users")
+public class UserV1Controller {
+    @GetMapping
+    public String getUsersV1() {
+        return "User list from API v1";
+    }
+}

spring-boot-modules/spring-boot-mvc-5/src/main/java/com/baeldung/versioning/controller/v2/UserV2Controller.java

@@ -0,0 +1,14 @@
+package com.baeldung.versioning.controller.v2;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/v2/users")
+public class UserV2Controller {
+    @GetMapping
+    public String getUsersV2() {
+        return "User list from API v2 with extra fields";
+    }
+}

spring-boot-modules/spring-boot-mvc-5/src/main/java/com/baeldung/versioning/model/UserV1.java

@@ -0,0 +1,9 @@
+package com.baeldung.versioning.model;
+
+public class UserV1 {
+    private String name;
+    public UserV1() {}
+    public UserV1(String name) { this.name = name; }
+    public String getName() { return name; }
+    public void setName(String name) { this.name = name; }
+}

spring-boot-modules/spring-boot-mvc-5/src/main/java/com/baeldung/versioning/model/UserV2.java

@@ -0,0 +1,18 @@
+package com.baeldung.versioning.model;
+
+public class UserV2 {
+    private String name;
+    private String email;
+    private int age;
+
+    public UserV2(String name, String email, int age) {
+        this.name = name;
+        this.email = email;
+        this.age = age;
+    }
+
+    // getters
+    public String getName() { return name; }
+    public String getEmail() { return email; }
+    public int getAge() { return age; }
+}