Merge pull request eugenp#288 from alexVengrovsk/master

Fixed code for Setting Up Swagger 2 with a Spring REST API article

Author: davidmorley

spring-security-rest/pom.xml

@@ -167,6 +167,19 @@
             <scope>test</scope>
         </dependency>
 
+        <!-- swagger -->
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+            <version>2.2.2</version>
+        </dependency>
+
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger-ui</artifactId>
+            <version>2.2.2</version>
+        </dependency>
+
     </dependencies>
 
     <build>
@@ -260,6 +273,10 @@
         <junit.version>4.11</junit.version>
         <mockito.version>1.10.19</mockito.version>
 
+        <!-- swagger -->
+        <springfox-swagger.version>2.2.2</springfox-swagger.version>
+        <springfox-swagger-ui.version>2.2.2</springfox-swagger-ui.version>
+
         <httpcore.version>4.4.1</httpcore.version>
         <httpclient.version>4.5</httpclient.version>
 

spring-security-rest/src/main/java/org/baeldung/spring/SwaggerConfig.java

@@ -0,0 +1,53 @@
+package org.baeldung.spring;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.bind.annotation.RequestMethod;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.builders.ResponseMessageBuilder;
+import springfox.documentation.schema.ModelRef;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+import static com.google.common.collect.Lists.newArrayList;
+
+@Configuration
+@EnableSwagger2
+public class SwaggerConfig {
+
+    @Bean
+    public Docket api(){
+        return new Docket(DocumentationType.SWAGGER_2)
+          .select()
+          .apis(RequestHandlerSelectors.basePackage("org.baeldung.web.controller"))
+          .paths(PathSelectors.ant("/foos/*"))
+          .build()
+          .apiInfo(apiInfo())
+          .useDefaultResponseMessages(false)
+          .globalResponseMessage(RequestMethod.GET,
+            newArrayList(new ResponseMessageBuilder()
+              .code(500)
+              .message("500 message")
+              .responseModel(new ModelRef("Error"))
+              .build(),
+              new ResponseMessageBuilder()
+                .code(403)
+                .message("Forbidden!!!!!")
+                .build()));
+    }
+
+    private ApiInfo apiInfo() {
+        ApiInfo apiInfo = new ApiInfo(
+          "My REST API",
+          "Some custom description of API.",
+          "API TOS",
+          "Terms of service",
+          "[email protected]",
+          "License of API",
+          "API license URL");
+        return apiInfo;
+    }
+}

spring-security-rest/src/main/java/org/baeldung/spring/WebConfig.java

@@ -3,6 +3,7 @@
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.servlet.config.annotation.EnableWebMvc;
+import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
 
 @Configuration
@@ -14,4 +15,13 @@ public WebConfig() {
         super();
     }
 
+    @Override
+    public void addResourceHandlers(ResourceHandlerRegistry registry) {
+        registry.addResourceHandler("swagger-ui.html")
+          .addResourceLocations("classpath:/META-INF/resources/");
+
+        registry.addResourceHandler("/webjars/**")
+          .addResourceLocations("classpath:/META-INF/resources/webjars/");
+    }
+
 }