From c5526428256f24b790c23023db6eb2e8ddd9c7da Mon Sep 17 00:00:00 2001 From: ziin Date: Fri, 31 Oct 2025 19:58:50 +0800 Subject: [PATCH] =?UTF-8?q?fix(swagger):=20=E4=BF=AE=E6=AD=A3Knife4j?= =?UTF-8?q?=E9=85=8D=E7=BD=AE=E5=B9=B6=E8=A1=A5=E5=85=85=E6=8E=A5=E5=8F=A3?= =?UTF-8?q?=E6=B3=A8=E8=A7=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 更新扫描包路径为正确包名 com.yolo.keyborad.controller - 修正文档标题与项目名 keyborad-backend 保持一致 - 在 DemoController 添加 @Api 及 @ApiOperation 注解 --- pom.xml | 11 ----------- .../java/com/yolo/keyborad/config/Knife4jConfig.java | 6 +++--- .../com/yolo/keyborad/controller/DemoController.java | 9 +++++++-- 3 files changed, 10 insertions(+), 16 deletions(-) diff --git a/pom.xml b/pom.xml index de139c0..f2bc898 100644 --- a/pom.xml +++ b/pom.xml @@ -31,13 +31,11 @@ mybatis-spring-boot-starter 2.2.2 - com.baomidou mybatis-plus-boot-starter 3.5.1 - org.springframework.boot spring-boot-starter-data-redis @@ -64,7 +62,6 @@ knife4j-spring-boot-starter 3.0.3 - cn.hutool hutool-all @@ -76,7 +73,6 @@ runtime true - org.postgresql postgresql @@ -103,7 +99,6 @@ cn.dev33 sa-token-spring-boot-starter 1.44.0 - compile @@ -112,12 +107,6 @@ 4.13.2 test - - - org.springframework.boot - spring-boot-starter-logging - - diff --git a/src/main/java/com/yolo/keyborad/config/Knife4jConfig.java b/src/main/java/com/yolo/keyborad/config/Knife4jConfig.java index a039b3c..5aca33f 100644 --- a/src/main/java/com/yolo/keyborad/config/Knife4jConfig.java +++ b/src/main/java/com/yolo/keyborad/config/Knife4jConfig.java @@ -25,13 +25,13 @@ public class Knife4jConfig { public Docket defaultApi2() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(new ApiInfoBuilder() - .title("project-backend") - .description("project-backend") + .title("keyborad-backend") + .description("keyborad-backend") .version("1.0") .build()) .select() // 指定 Controller 扫描包路径 - .apis(RequestHandlerSelectors.basePackage("com.yupi.project.controller")) + .apis(RequestHandlerSelectors.basePackage("com.yolo.keyborad.controller")) .paths(PathSelectors.any()) .build(); } diff --git a/src/main/java/com/yolo/keyborad/controller/DemoController.java b/src/main/java/com/yolo/keyborad/controller/DemoController.java index 075b8dd..cdac54c 100644 --- a/src/main/java/com/yolo/keyborad/controller/DemoController.java +++ b/src/main/java/com/yolo/keyborad/controller/DemoController.java @@ -2,6 +2,10 @@ package com.yolo.keyborad.controller; import com.yolo.keyborad.common.BaseResponse; import com.yolo.keyborad.common.ResultUtils; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.tags.Tag; import lombok.extern.slf4j.Slf4j; import org.springframework.web.bind.annotation.CrossOrigin; import org.springframework.web.bind.annotation.GetMapping; @@ -16,11 +20,12 @@ import org.springframework.web.bind.annotation.RestController; @RequestMapping("/demo") @Slf4j @CrossOrigin +@Api(tags = "测试控制器") public class DemoController { @GetMapping("/test") - public BaseResponse hostsInfo(){ - + @ApiOperation("测试接口") + public BaseResponse testDemo(){ return ResultUtils.success("hello world"); } }