knife4J文档相关

pom.xml

@@ -333,6 +333,21 @@
             <artifactId>commons-text</artifactId>
             <version>1.1</version>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.plugin</groupId>
+            <artifactId>spring-plugin-core</artifactId>
+            <version>2.0.0.RELEASE</version>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.plugin</groupId>
+            <artifactId>spring-plugin-metadata</artifactId>
+            <version>2.0.0.RELEASE</version>
+        </dependency>
+        <dependency>
+            <groupId>com.github.xiaoymin</groupId>
+            <artifactId>knife4j-spring-boot-starter</artifactId>
+            <version>2.0.9</version>
+        </dependency>
     </dependencies>
 
     <build>

src/main/java/com/glxp/api/config/Knife4jConfiguration.java

@@ -0,0 +1,37 @@
+package com.glxp.api.config;
+
+
+import org.springframework.beans.factory.annotation.Value;
+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.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
+
+@Configuration
+@EnableSwagger2WebMvc
+public class Knife4jConfiguration {
+
+    @Value("${knife4j.enable:false}")
+    private boolean enable;
+
+    @Bean(value = "defaultApi2")
+    public Docket defaultApi2() {
+        Docket docket = new Docket(DocumentationType.SWAGGER_2)
+                .apiInfo(new ApiInfoBuilder()
+                        .title("UDI管理系统后台")
+                        .description("UDI管理系统后台 - APIS")
+                        .version("1.0")
+                        .build())
+                .enable(enable)
+                .select()
+                //这里指定Controller扫描包路径
+                .apis(RequestHandlerSelectors.basePackage("com.glxp.api.controller"))
+                .paths(PathSelectors.any())
+                .build();
+        return docket;
+    }
+}

src/main/java/com/glxp/api/controller/sync/SpsSyncDownloadController.java

@@ -47,6 +47,8 @@ import com.glxp.api.service.sync.SpsSyncDownloadService;
 import com.glxp.api.util.CustomUtil;
 import com.glxp.api.util.DateUtil;
 import com.glxp.api.util.JsonUtils;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.apache.ibatis.session.ExecutorType;
 import org.apache.ibatis.session.SqlSession;
 import org.apache.ibatis.session.SqlSessionFactory;
@@ -65,6 +67,7 @@ import java.io.IOException;
 import java.util.*;
 
 @RestController
+@Api(tags = "同步下载相关")
 public class SpsSyncDownloadController {
 
     @Resource
@@ -151,6 +154,7 @@ public class SpsSyncDownloadController {
     //    下发基础数据 ，供给中继服务，UDI管理系统下载
     @AuthRuleAnnotation("")
     @GetMapping("sps/sync/data")
+    @ApiOperation("拉取同步任务数据")
     public BaseResponse data(BasicExportTypeEnum exportType) {
         BaseResponse<RelaySyncResponse> baseResponse = new BaseResponse<>();
         BasicExportStatusEntity one = basicExportService.getOne(Wrappers.lambdaQuery(BasicExportStatusEntity.class)