Kaynağa Gözat

提交惯用路线开发

chenxiaofei 8 ay önce
ebeveyn
işleme
0e639ba5f9

+ 6 - 0
pom.xml

@@ -69,6 +69,7 @@
         <maven-resources-plugin.version>3.3.0</maven-resources-plugin.version>
         <maven-install-plugin.version>3.0.1</maven-install-plugin.version>
         <maven-deploy-plugin.version>3.0.0</maven-deploy-plugin.version>
+        <maven-openapi-ui.version>1.7.0</maven-openapi-ui.version>
     </properties>
 
     <dependencyManagement>
@@ -350,6 +351,11 @@
                 <optional>true</optional>
             </dependency>
 
+            <dependency>
+                <groupId>org.springdoc</groupId>
+                <artifactId>springdoc-openapi-ui</artifactId>
+                <version>${maven-openapi-ui.version}</version>
+            </dependency>
         </dependencies>
     </dependencyManagement>
 

+ 5 - 0
sckw-common/sckw-common-core/pom.xml

@@ -178,5 +178,10 @@
             <groupId>org.apache.httpcomponents.client5</groupId>
             <artifactId>httpclient5</artifactId>
         </dependency>
+
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-ui</artifactId>
+        </dependency>
     </dependencies>
 </project>

+ 23 - 0
sckw-common/sckw-common-core/src/main/java/com/sckw/core/config/OpenApiConfig.java

@@ -0,0 +1,23 @@
+package com.sckw.core.config;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * @author PC
+ */
+@Configuration
+public class OpenApiConfig {
+    @Bean
+    public OpenAPI customOpenAPI() {
+        return new OpenAPI()
+                .info(new Info()
+                        .title("API文档")
+                        .version("1.0")
+                        .description("<font color=\"#DC143C\">**以「高质量代码」为核心,「简洁、高效、安全」**</font>基于 SpringBoot + Sa-Token + Mybatis-Plus 和 Vue3 + Vite5 + Ant Design (同时支持JavaScript和TypeScript双版本) 的快速开发平台。" +
+                                "<br/><font color=\"#DC143C\">**国内首个满足《网络安全》、《数据安全》、三级等保**</font>, 支持登录限制、支持国产接口加解密等安全、支持数据加解密等一系列安全体系的开源项目。" +
+                                "<br/><font color=\"#DC143C\">**我们开源一套漂亮的代码和一套整洁的代码规范**</font>,让大家在这浮躁的代码世界里感受到一股把代码写好的清流!同时又让开发者节省大量的时间,减少加班,快乐工作,保持谦逊,保持学习,热爱代码,更热爱生活!"));
+    }
+}

+ 28 - 0
sckw-common/sckw-common-core/src/main/java/com/sckw/core/config/SwaggerConfig.java

@@ -0,0 +1,28 @@
+package com.sckw.core.config;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.info.Contact;
+import io.swagger.v3.oas.models.info.License;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class SwaggerConfig {
+    
+    @Bean
+    public OpenAPI customOpenAPI() {
+        return new OpenAPI()
+                .info(new Info()
+                        .title("API 文档")
+                        .version("1.0")
+                        .description("Spring Boot REST API 文档")
+                        .contact(new Contact()
+                                .name("矿拉拉普适版")
+                                .email("dev@example.com")
+                                .url("https://example.com"))
+                        .license(new License()
+                                .name("Apache 2.0")
+                                .url("http://springdoc.org")));
+    }
+}

+ 5 - 4
sckw-modules/sckw-transport/src/main/java/com/sckw/transport/controller/KwfTaskController.java

@@ -1,14 +1,13 @@
 package com.sckw.transport.controller;
 
-import com.sckw.core.annotation.ApiVersion;
 import com.sckw.core.web.response.BaseResult;
 import com.sckw.transport.model.TaskStatisticsVo;
-
 import com.sckw.transport.service.KwfTaskService;
-import com.sckw.transport.service.kwfTruckTraceService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PostMapping;
+
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
@@ -20,6 +19,7 @@ import org.springframework.web.bind.annotation.RestController;
 @RestController
 @RequestMapping("/task")
 @RequiredArgsConstructor
+@Tag(name = "任务和车辆数据统计模块", description = "任务和车辆数据统计模块")
 public class KwfTaskController {
     private final KwfTaskService kwfTaskService;
 
@@ -27,6 +27,7 @@ public class KwfTaskController {
      * 任务和车辆数据统计
      */
     @GetMapping("/taskStatistics")
+    @Operation(summary = "任务和车辆数据统计", description = "任务和车辆数据统计")
     public BaseResult<TaskStatisticsVo> getTaskStatistics()  {
         TaskStatisticsVo truckInfoVo = kwfTaskService.getTaskStatistics();
         return BaseResult.success(truckInfoVo);

+ 1 - 1
sckw-modules/sckw-transport/src/main/java/com/sckw/transport/controller/KwfTruckTraceController.java

@@ -45,7 +45,7 @@ public class KwfTruckTraceController {
     /**
      * 查询当前车辆的轨迹明细
      */
-    @PostMapping("/queryCurrentTaskTrace")
+    @PostMapping("/queryCurrentTruckTrace")
     public BaseResult<CurrentTaskTraceReqVo> queryCurrentTruckTrace(@RequestBody CurrentTaskTraceReq req )  {
         CurrentTaskTraceReqVo taskTrace = kwfTruckTraceService.queryCurrentTruckTrace(req);
         return BaseResult.success(taskTrace);