add swagger in efs-misc

efs-misc/pom.xml

@@ -11,5 +11,56 @@
 
     <artifactId>efs-misc</artifactId>
 
+    <properties>
+        <swagger.version>2.9.0</swagger.version>
+    </properties>
+
+
+    <dependencies>
+        <!--swagger2 enable dependency-->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-configuration-processor</artifactId>
+            <optional>true</optional>
+        </dependency>
+
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+            <version>${swagger.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger-ui</artifactId>
+            <version>${swagger.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>com.github.caspar-chen</groupId>
+            <artifactId>swagger-ui-layer</artifactId>
+            <version>0.0.4</version>
+        </dependency>
+
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-bean-validators</artifactId>
+            <version>${swagger.version}</version>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <!--跳过测试插件-->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>2.20</version>
+                <configuration>
+                    <skipTests>true</skipTests>    <!--默认关掉单元测试 -->
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
 
 </project>
\ No newline at end of file

efs-misc/src/main/java/com/zjty/efs/misc/config/AutoDocument.java

+package com.zjty.efs.misc.config;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+/**
+ * fusion-platform. swagger2 autoDocument interface for {@link Swagger2Config}
+ *
+ * @author : Matrix [xhyrzldf@gmail.com]
+ * 19-1-10 .
+ */
+@Target({TYPE, ANNOTATION_TYPE})
+@Retention(RUNTIME)
+@Documented
+public @interface AutoDocument {
+
+    String value() default "";
+}

efs-misc/src/main/java/com/zjty/efs/misc/config/Swagger2Config.java

+package com.zjty.efs.misc.config;
+
+import com.google.common.collect.Sets;
+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;
+
+/**
+ * fusion-platform.
+ *
+ * @author : Matrix [xhyrzldf@gmail.com]
+ * 19-1-10 .
+ */
+@Configuration
+@EnableSwagger2
+public class Swagger2Config {
+
+    @Bean
+    public Docket createRestApi() {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .produces(Sets.newHashSet("application/json"))
+                .consumes(Sets.newHashSet("application/json"))
+                .protocols(Sets.newHashSet("http"))
+                .apiInfo(apiInfo())
+                .forCodeGeneration(true)
+                .useDefaultResponseMessages(true)
+//                .globalResponseMessage(RequestMethod.GET, getResMsg())
+                .select()
+                // 指定controller存放的目录路径
+                .apis(RequestHandlerSelectors.withClassAnnotation(AutoDocument.class))
+                .paths(PathSelectors.any())
+                .build();
+    }
+
+    private ApiInfo apiInfo() {
+        return new ApiInfoBuilder()
+                // 文档标题
+                .title("融合平台接口文档")
+                // 文档描述
+                .description("融合平台的接口文档与测试页面")
+                .termsOfServiceUrl("http://192.168.1.155:8080/fusion-group/fusion-platform")
+                .version("v1")
+                .contact(new Contact("fusion-group", "http://192.168.1.155:8080/fusion-group/fusion-platform", "fusion-group@example.com"))
+                .build();
+    }
+
+//    private ArrayList<ResponseMessage> getResMsg() {
+//        return newArrayList(new ResponseMessageBuilder()
+//                        .code(500)
+//                        .message("服务器内部发生了某种错误")
+//                        .responseModel(new ModelRef("Error"))
+//                        .build(),
+//                new ResponseMessageBuilder()
+//                        .code(404)
+//                        .message("用户发出的请求针对的是不存在的记录，服务器没有进行操作")
+//                        .responseModel(new ModelRef("Exception"))
+//                        .build(),
+//                new ResponseMessageBuilder()
+//                        .code(406)
+//                        .message("用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）")
+//                        .responseModel(new ModelRef("Exception"))
+//                        .build(),
+//                new ResponseMessageBuilder()
+//                        .code(501)
+//                        .message("不支持的HTTP请求，请检查HTTP TYPE与资源路径是否正确")
+//                        .responseModel(new ModelRef("Exception"))
+//                        .build());
+//    }
+
+}