[JAVA-14985] Moved code related to articles from spring-boot-mvc-2 to spring-boot-swagger-2

spring-boot-modules/spring-boot-mvc-2/README.md

@@ -5,8 +5,6 @@ This module contains articles about Spring Web MVC in Spring Boot projects.
 ### Relevant Articles:
 
 - [Functional Controllers in Spring MVC](https://www.baeldung.com/spring-mvc-functional-controllers)
-- [Specify an Array of Strings as Body Parameters in Swagger](https://www.baeldung.com/swagger-body-array-of-strings)
-- [Swagger @ApiParam vs @ApiModelProperty](https://www.baeldung.com/swagger-apiparam-vs-apimodelproperty)
 - [Testing REST with multiple MIME types](https://www.baeldung.com/testing-rest-api-with-multiple-media-types)
 - [Testing Web APIs with Postman Collections](https://www.baeldung.com/postman-testing-collections)
 - [Spring Boot Consuming and Producing JSON](https://www.baeldung.com/spring-boot-json)

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

@@ -90,8 +90,7 @@
 
     <properties>
         <spring.fox.version>3.0.0</spring.fox.version>
-        <start-class>com.baeldung.swagger2boot.SpringBootSwaggerApplication</start-class>
+        <start-class>com.baeldung.springbootmvc.SpringBootMvcFnApplication</start-class>
-        <!-- <start-class>com.baeldung.springbootmvc.SpringBootMvcFnApplication</start-class> -->
         <xstream.version>1.4.11.1</xstream.version>
     </properties>
 

spring-boot-modules/spring-boot-swagger-2/README.md

@@ -1,3 +1,5 @@
 ### Relevant Articles:
 
 - [Swagger: Specify Two Responses with the Same Response Code](https://www.baeldung.com/swagger-two-responses-one-response-code)
+- [Specify an Array of Strings as Body Parameters in Swagger](https://www.baeldung.com/swagger-body-array-of-strings)
+- [Swagger @ApiParam vs @ApiModelProperty](https://www.baeldung.com/swagger-apiparam-vs-apimodelproperty)

spring-boot-modules/spring-boot-swagger-2/pom.xml

@@ -39,6 +39,47 @@
             <groupId>javax.validation</groupId>
             <artifactId>validation-api</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+            <version>${springfox.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-spring-webmvc</artifactId>
+            <version>${springfox.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-devtools</artifactId>
+            <optional>true</optional>
+        </dependency>
+        <!-- Swagger dependencies for REST documentation -->
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-data-jpa</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.h2database</groupId>
+            <artifactId>h2</artifactId>
+        </dependency>
+
     </dependencies>
 
     <build>
@@ -70,6 +111,7 @@
         <springfox.version>3.0.0</springfox.version>
         <swagger-codegen-maven-plugin.version>3.0.34</swagger-codegen-maven-plugin.version>
         <springdoc.version>1.6.10</springdoc.version>
+        <swagger-maven-plugin.version>3.1.1</swagger-maven-plugin.version>
     </properties>
 
 </project>

spring-boot-modules/spring-boot-swagger-2/src/main/java/com/baeldung/swagger2bootmvc/SpringBootSwaggerApplication.java

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

spring-boot-modules/spring-boot-swagger-2/src/main/java/com/baeldung/swagger2bootmvc/config/Swagger2Config.java

@@ -0,0 +1,38 @@
+package com.baeldung.swagger2bootmvc.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.EnableWebMvc;
+
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+
+@Configuration
+@EnableWebMvc
+@EnableSwagger2
+public class Swagger2Config {
+    @Bean
+    public Docket api() {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .select()
+                .apis(RequestHandlerSelectors.any())
+                .paths(PathSelectors.any())
+                .build()
+                .apiInfo(apiEndPointsInfo());
+    }
+
+    private ApiInfo apiEndPointsInfo() {
+        return new ApiInfoBuilder().title("Swagger Array")
+            .description("This is a sample Swagger description for an Array server")
+            .license("Apache 2.0")
+            .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
+            .version("1.0.0")
+            .build();
+    }
+}

spring-boot-modules/spring-boot-swagger-2/src/main/java/com/baeldung/swagger2bootmvc/controller/FooController.java

@@ -0,0 +1,35 @@
+package com.baeldung.swagger2bootmvc.controller;
+
+import static org.apache.commons.lang3.RandomStringUtils.randomNumeric;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+import com.baeldung.swagger2bootmvc.model.Foo;
+
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+
+@Controller
+public class FooController {
+
+    public FooController() {
+        super();
+    }
+
+    // API - write
+    @RequestMapping(method = RequestMethod.POST, value = "/foos")
+    @ResponseStatus(HttpStatus.CREATED)
+    @ResponseBody
+    @ApiImplicitParams({ @ApiImplicitParam(name = "foo", value = "List of strings", paramType = "body", dataType = "Foo") })
+    public Foo create(@RequestBody final Foo foo) {
+        foo.setId(Long.parseLong(randomNumeric(2)));
+        return foo;
+    }
+
+}

spring-boot-modules/spring-boot-swagger-2/src/main/java/com/baeldung/swagger2bootmvc/controller/UserController.java

@@ -0,0 +1,37 @@
+package com.baeldung.swagger2bootmvc.controller;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+import com.baeldung.swagger2bootmvc.model.User;
+
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
+
+@Controller
+public class UserController {
+
+    public UserController() {
+        super();
+    } //@formatter:off
+
+    @RequestMapping(method = RequestMethod.POST, value = "/createUser", produces = "application/json; charset=UTF-8")
+    @ResponseStatus(HttpStatus.CREATED)
+    @ResponseBody
+    @ApiOperation(value = "Create user",
+            notes = "This method creates a new user")
+    public User createUser(@ApiParam(
+                    name =  "firstName",
+                    type = "String",
+                    value = "First Name of the user",
+                    example = "Vatsal",
+                    required = true) @RequestParam String firstName) { //@formatter:on
+        User user = new User(firstName);
+        return user;
+    }
+}

spring-boot-modules/spring-boot-swagger-2/src/main/java/com/baeldung/swagger2bootmvc/model/Foo.java

@@ -0,0 +1,44 @@
+package com.baeldung.swagger2bootmvc.model;
+
+import java.util.List;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+
+@ApiModel
+public class Foo {
+    private long id;
+
+    @ApiModelProperty(name = "name", dataType = "List", example = "[\"str1\", \"str2\", \"str3\"]")
+    private List<String> name;
+
+    public Foo() {
+        super();
+    }
+
+    public Foo(final long id, final List<String> name) {
+        super();
+
+        this.id = id;
+        this.name = name;
+    }
+
+    //
+
+    public long getId() {
+        return id;
+    }
+
+    public void setId(final long id) {
+        this.id = id;
+    }
+
+    public List<String> getName() {
+        return name;
+    }
+
+    public void setName(final List<String> name) {
+        this.name = name;
+    }
+
+}

spring-boot-modules/spring-boot-swagger-2/src/main/java/com/baeldung/swagger2bootmvc/model/User.java

@@ -0,0 +1,28 @@
+package com.baeldung.swagger2bootmvc.model;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+
+@ApiModel
+public class User {
+
+    @ApiModelProperty(value = "first name of the user", name = "firstName", dataType = "String", example = "Vatsal")
+    String firstName;
+
+    public User() {
+        super();
+    }
+
+    public User(final String firstName) {
+        super();
+        this.firstName = firstName;
+    }
+
+    public String getFirstName() {
+        return firstName;
+    }
+
+    public void setFirstName(String firstName) {
+        this.firstName = firstName;
+    }
+}

spring-boot-modules/spring-boot-swagger-2/src/main/resources/swagger-description.yml

@@ -0,0 +1,33 @@
+swagger: "2.0"
+info:
+  description: "This is a sample Swagger description for an Array server"
+  version: "1.0.0"
+  title: "Swagger Array"
+  license:
+    name: "Apache 2.0"
+    url: "http://www.apache.org/licenses/LICENSE-2.0.html"
+basePath: "/localhost:8080/"
+tags:
+- name: "foo-controller"
+  description: "Foo controller"
+
+paths:
+  /foos:
+    post:
+      tags:
+      - "foo-controller"
+      summary: "create"
+      description: ""
+      parameters:
+        - in: body
+          description: ""
+          required: true
+          name: name
+          schema:
+            type: array
+            items:
+              type: string
+            example: ["str1", "str2", "str3"]
+      responses:
+        default:
+          description: OK