整合Swagger2

horseInsect · Apr 18, 2018 · 5b8ddf7 · 5b8ddf7
1 parent 41380ae
commit 5b8ddf7
Show file tree

Hide file tree

Showing 9 changed files with 181 additions and 24 deletions.
diff --git a/mss-gateway/pom.xml b/mss-gateway/pom.xml
@@ -18,37 +18,43 @@
 	<dependencies>
 		<dependency>
 			<groupId>org.springframework.cloud</groupId>
-			<artifactId>spring-cloud-starter-zuul</artifactId>
+			<artifactId>spring-cloud-starter-netflix-zuul</artifactId>
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.cloud</groupId>
-			<artifactId>spring-cloud-starter-eureka</artifactId>
+			<artifactId>spring-cloud-starter-oauth2</artifactId>
 		</dependency>
-
 		<dependency>
-			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-test</artifactId>
-			<scope>test</scope>
+			<groupId>org.springframework.retry</groupId>
+			<artifactId>spring-retry</artifactId>
 		</dependency>
+		<!--注册中心-->
 		<dependency>
-			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-actuator</artifactId>
+			<groupId>org.springframework.cloud</groupId>
+			<artifactId>spring-cloud-starter-eureka</artifactId>
 		</dependency>
+		<!--Ribbon-->
 		<dependency>
 			<groupId>org.springframework.cloud</groupId>
-			<artifactId>spring-cloud-starter-security</artifactId>
+			<artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
 		</dependency>
-
 		<dependency>
 			<groupId>org.springframework.cloud</groupId>
-			<artifactId>spring-cloud-starter-oauth2</artifactId>
+			<artifactId>spring-cloud-starter-feign</artifactId>
 		</dependency>
 		<dependency>
-			<groupId>org.springframework.retry</groupId>
-			<artifactId>spring-retry</artifactId>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-actuator</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-swagger2</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-swagger-ui</artifactId>
 		</dependency>
 	</dependencies>
-
 	<build>
 		<plugins>
 			<plugin>

diff --git a/mss-gateway/src/main/java/com/microservice/skeleton/gateway/config/SecurityConfig.java b/mss-gateway/src/main/java/com/microservice/skeleton/gateway/config/SecurityConfig.java
@@ -16,6 +16,7 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter{
 
     @Override
     protected void configure(HttpSecurity http) throws Exception {
+        http.authorizeRequests().mvcMatchers("/v2/api-docs ").permitAll();
         http.csrf().disable();
     }
 }
diff --git a/...ava/com/microservice/skeleton/gateway/config/swagger/GatewaySwaggerResourcesProvider.java b/...ava/com/microservice/skeleton/gateway/config/swagger/GatewaySwaggerResourcesProvider.java
@@ -0,0 +1,45 @@
+package com.microservice.skeleton.gateway.config.swagger;
+
+import org.springframework.cloud.netflix.zuul.filters.Route;
+import org.springframework.cloud.netflix.zuul.filters.RouteLocator;
+import org.springframework.context.annotation.Primary;
+import org.springframework.stereotype.Component;
+import springfox.documentation.swagger.web.SwaggerResource;
+import springfox.documentation.swagger.web.SwaggerResourcesProvider;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Created with IntelliJ IDEA.
+ * Description:
+ * User: Mr.Yangxiufeng
+ * Date: 2018-04-18
+ * Time: 14:56
+ */
+@Component
+@Primary
+public class GatewaySwaggerResourcesProvider implements SwaggerResourcesProvider {
+    private final RouteLocator routeLocator;
+
+    public GatewaySwaggerResourcesProvider(RouteLocator routeLocator) {
+        this.routeLocator = routeLocator;
+    }
+
+    @Override
+    public List<SwaggerResource> get() {
+        List<SwaggerResource> resources = new ArrayList<>();
+        List<Route> routes = routeLocator.getRoutes();
+        for (Route route:routes) {
+            resources.add(swaggerResource(route.getId(), route.getFullPath().replace("**", "v2/api-docs")));
+        }
+        return resources;
+    }
+    private SwaggerResource swaggerResource(String name, String location) {
+        SwaggerResource swaggerResource = new SwaggerResource();
+        swaggerResource.setName(name);
+        swaggerResource.setLocation(location);
+        swaggerResource.setSwaggerVersion("2.0");
+        return swaggerResource;
+    }
+}
diff --git a/...ateway/src/main/java/com/microservice/skeleton/gateway/config/swagger/Swagger2Config.java b/...ateway/src/main/java/com/microservice/skeleton/gateway/config/swagger/Swagger2Config.java
@@ -0,0 +1,37 @@
+package com.microservice.skeleton.gateway.config.swagger;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.service.Contact;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+/**
+ * Created with IntelliJ IDEA.
+ * Description:
+ * User: Mr.Yangxiufeng
+ * Date: 2018-04-18
+ * Time: 14:55
+ */
+@Configuration
+@EnableSwagger2
+public class Swagger2Config {
+    @Bean
+    public Docket createRestApi() {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .apiInfo(apiInfo());
+    }
+
+    private ApiInfo apiInfo() {
+        return new ApiInfoBuilder()
+                .title("说明文档")
+                .description("接口说明文档")
+                .termsOfServiceUrl("")
+                .contact(new Contact("杨秀峰","[email protected]","[email protected]"))
+                .version("1.0")
+                .build();
+    }
+}
diff --git a/mss-gateway/src/main/resources/application.yml b/mss-gateway/src/main/resources/application.yml
@@ -47,7 +47,8 @@ security:
     enabled: false
   oauth2:
     client:
-      access-token-uri: http://localhost:9030/uaa/oauth/token ##网关的地址
+      ##网关的地址
+      access-token-uri: http://localhost:9030/uaa/oauth/token
       user-authorization-uri: http://localhost:9030/uaa/oauth/authorize
     resource:
       user-info-uri:  http://localhost:9030/uaa/user

diff --git a/mss-resource/pom.xml b/mss-resource/pom.xml
@@ -36,6 +36,16 @@
 			<artifactId>spring-boot-starter-test</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-swagger2</artifactId>
+			<version>${swagger2.version}</version>
+		</dependency>
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-swagger-ui</artifactId>
+			<version>${swagger2.version}</version>
+		</dependency>
 	</dependencies>
 
 	<build>

diff --git a/...esource/src/main/java/com/microservice/skeleton/resource/config/ResourceServerConfig.java b/...esource/src/main/java/com/microservice/skeleton/resource/config/ResourceServerConfig.java
@@ -21,7 +21,9 @@ public void configure(HttpSecurity http) throws Exception {
                 .exceptionHandling()
                 .authenticationEntryPoint(new Http401AuthenticationEntryPoint("Bearer realm=\"webrealm\""))
                 .and()
-                .authorizeRequests().anyRequest().authenticated()
+                .authorizeRequests()
+                .mvcMatchers("/v2/api-docs").permitAll()
+                .anyRequest().authenticated()
                 .and()
                 .httpBasic();
     }

diff --git a/mss-resource/src/main/java/com/microservice/skeleton/resource/config/Swagger2Config.java b/mss-resource/src/main/java/com/microservice/skeleton/resource/config/Swagger2Config.java
@@ -0,0 +1,43 @@
+package com.microservice.skeleton.resource.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.service.Contact;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+/**
+ * Created with IntelliJ IDEA.
+ * Description:
+ * User: Mr.Yangxiufeng
+ * Date: 2018-04-18
+ * Time: 14:52
+ */
+@EnableSwagger2
+@Configuration
+public class Swagger2Config {
+    @Bean
+    public Docket createRestApi() {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .apiInfo(apiInfo())
+                .select()
+                .apis(RequestHandlerSelectors.basePackage("com.microservice.skeleton.resource.controller"))
+                .paths(PathSelectors.any())
+                .build();
+    }
+
+    private ApiInfo apiInfo() {
+        return new ApiInfoBuilder()
+                .title("resource文档")
+                .description("resource接口说明文档")
+                .termsOfServiceUrl("")
+                .contact(new Contact("杨秀峰","[email protected]","[email protected]"))
+                .version("1.0")
+                .build();
+    }
+}
diff --git a/pom.xml b/pom.xml
@@ -17,6 +17,8 @@
 		<java.version>1.8</java.version>
 		<spring-cloud.version>Edgware.RELEASE</spring-cloud.version>
 		<druid-starter.version>1.1.6</druid-starter.version>
+		<swagger2.version>2.8.0</swagger2.version>
+		<lombok.version>1.16.20</lombok.version>
 	</properties>
 	<parent>
 		<groupId>org.springframework.boot</groupId>
@@ -31,17 +33,16 @@
 		<module>mss-resource</module>
 	</modules>
 	<dependencies>
+		<!--Lombok-->
 		<dependency>
-			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-actuator</artifactId>
-		</dependency>
-		<dependency>
-			<groupId>org.springframework.cloud</groupId>
-			<artifactId>spring-cloud-starter-sleuth</artifactId>
+			<groupId>org.projectlombok</groupId>
+			<artifactId>lombok</artifactId>
+			<version>${lombok.version}</version>
 		</dependency>
 		<dependency>
-			<groupId>org.springframework.cloud</groupId>
-			<artifactId>spring-cloud-starter-zipkin</artifactId>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
 		</dependency>
 	</dependencies>
 	<dependencyManagement>
@@ -63,6 +64,17 @@
 				<artifactId>druid-spring-boot-starter</artifactId>
 				<version>${druid-starter.version}</version>
 			</dependency>
+			<!--swagger ui-->
+			<dependency>
+				<groupId>io.springfox</groupId>
+				<artifactId>springfox-swagger2</artifactId>
+				<version>${swagger2.version}</version>
+			</dependency>
+			<dependency>
+				<groupId>io.springfox</groupId>
+				<artifactId>springfox-swagger-ui</artifactId>
+				<version>${swagger2.version}</version>
+			</dependency>
 		</dependencies>
 	</dependencyManagement>