From 0b993fc0ab89973ebcc00dc3612ac40d7c6882a5 Mon Sep 17 00:00:00 2001 From: nagocoler Date: Wed, 13 Nov 2024 13:58:52 +0800 Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0Swagger=E9=85=8D=E7=BD=AE?= =?UTF-8?q?=EF=BC=8C=E4=BF=AE=E5=A4=8DPOM=E6=96=87=E4=BB=B6=E6=8A=A5?= =?UTF-8?q?=E9=94=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pom.xml | 2 - ruoyi-admin/pom.xml | 12 -- .../system/SysConfigController.java | 3 + .../web/controller/tool/TestController.java | 175 ------------------ .../src/main/resources/application.yml | 11 +- ruoyi-system/pom.xml | 6 + .../com/ruoyi/system/domain/SysConfig.java | 3 + 7 files changed, 20 insertions(+), 192 deletions(-) delete mode 100644 ruoyi-admin/src/main/java/com/ruoyi/web/controller/tool/TestController.java diff --git a/pom.xml b/pom.xml index 5985760..25afb8f 100644 --- a/pom.xml +++ b/pom.xml @@ -198,8 +198,6 @@ ruoyi-admin ruoyi-framework ruoyi-system - ruoyi-quartz - ruoyi-generator ruoyi-common ruoyi-core diff --git a/ruoyi-admin/pom.xml b/ruoyi-admin/pom.xml index c366907..8490501 100644 --- a/ruoyi-admin/pom.xml +++ b/ruoyi-admin/pom.xml @@ -42,18 +42,6 @@ ruoyi-framework - - - com.ruoyi - ruoyi-quartz - - - - - com.ruoyi - ruoyi-generator - - com.ruoyi ruoyi-core diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysConfigController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysConfigController.java index 6303471..3a6989c 100644 --- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysConfigController.java +++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysConfigController.java @@ -1,6 +1,8 @@ package com.ruoyi.web.controller.system; import java.util.List; + +import io.swagger.v3.oas.annotations.Operation; import jakarta.servlet.http.HttpServletResponse; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.security.access.prepost.PreAuthorize; @@ -37,6 +39,7 @@ public class SysConfigController extends BaseController /** * 获取参数配置列表 */ + @Operation(summary = "获取配置列表") @PreAuthorize("@ss.hasPermi('system:config:list')") @GetMapping("/list") public TableDataInfo list(SysConfig config) diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/tool/TestController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/tool/TestController.java deleted file mode 100644 index b56a097..0000000 --- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/tool/TestController.java +++ /dev/null @@ -1,175 +0,0 @@ -package com.ruoyi.web.controller.tool; - -import java.util.ArrayList; -import java.util.LinkedHashMap; -import java.util.List; -import java.util.Map; -import org.springframework.web.bind.annotation.DeleteMapping; -import org.springframework.web.bind.annotation.GetMapping; -import org.springframework.web.bind.annotation.PathVariable; -import org.springframework.web.bind.annotation.PostMapping; -import org.springframework.web.bind.annotation.PutMapping; -import org.springframework.web.bind.annotation.RequestBody; -import org.springframework.web.bind.annotation.RequestMapping; -import org.springframework.web.bind.annotation.RestController; -import com.ruoyi.common.core.controller.BaseController; -import com.ruoyi.common.core.domain.R; -import com.ruoyi.common.utils.StringUtils; -import io.swagger.v3.oas.annotations.Operation; -import io.swagger.v3.oas.annotations.media.Schema; -import io.swagger.v3.oas.annotations.tags.Tag; - -/** - * swagger 用户测试方法 - * - * @author ruoyi - */ -@Tag(name = "用户信息管理") -@RestController -@RequestMapping("/test/user") -public class TestController extends BaseController -{ - private final static Map users = new LinkedHashMap(); - { - users.put(1, new UserEntity(1, "admin", "admin123", "15888888888")); - users.put(2, new UserEntity(2, "ry", "admin123", "15666666666")); - } - - @Operation(summary = "获取用户列表") - @GetMapping("/list") - public R> userList() - { - List userList = new ArrayList(users.values()); - return R.ok(userList); - } - - @Operation(summary = "获取用户详细") - @GetMapping("/{userId}") - public R getUser(@PathVariable(name = "userId") - Integer userId) - { - if (!users.isEmpty() && users.containsKey(userId)) - { - return R.ok(users.get(userId)); - } - else - { - return R.fail("用户不存在"); - } - } - - @Operation(summary = "新增用户") - @PostMapping("/save") - public R save(UserEntity user) - { - if (StringUtils.isNull(user) || StringUtils.isNull(user.getUserId())) - { - return R.fail("用户ID不能为空"); - } - users.put(user.getUserId(), user); - return R.ok(); - } - - @Operation(summary = "更新用户") - @PutMapping("/update") - public R update(@RequestBody - UserEntity user) - { - if (StringUtils.isNull(user) || StringUtils.isNull(user.getUserId())) - { - return R.fail("用户ID不能为空"); - } - if (users.isEmpty() || !users.containsKey(user.getUserId())) - { - return R.fail("用户不存在"); - } - users.remove(user.getUserId()); - users.put(user.getUserId(), user); - return R.ok(); - } - - @Operation(summary = "删除用户信息") - @DeleteMapping("/{userId}") - public R delete(@PathVariable(name = "userId") - Integer userId) - { - if (!users.isEmpty() && users.containsKey(userId)) - { - users.remove(userId); - return R.ok(); - } - else - { - return R.fail("用户不存在"); - } - } -} - -@Schema(description = "用户实体") -class UserEntity -{ - @Schema(title = "用户ID") - private Integer userId; - - @Schema(title = "用户名称") - private String username; - - @Schema(title = "用户密码") - private String password; - - @Schema(title = "用户手机") - private String mobile; - - public UserEntity() - { - - } - - public UserEntity(Integer userId, String username, String password, String mobile) - { - this.userId = userId; - this.username = username; - this.password = password; - this.mobile = mobile; - } - - public Integer getUserId() - { - return userId; - } - - public void setUserId(Integer userId) - { - this.userId = userId; - } - - public String getUsername() - { - return username; - } - - public void setUsername(String username) - { - this.username = username; - } - - public String getPassword() - { - return password; - } - - public void setPassword(String password) - { - this.password = password; - } - - public String getMobile() - { - return mobile; - } - - public void setMobile(String mobile) - { - this.mobile = mobile; - } -} diff --git a/ruoyi-admin/src/main/resources/application.yml b/ruoyi-admin/src/main/resources/application.yml index d300f2e..528d00c 100644 --- a/ruoyi-admin/src/main/resources/application.yml +++ b/ruoyi-admin/src/main/resources/application.yml @@ -122,10 +122,15 @@ springdoc: path: /swagger-ui.html tags-sorter: alpha group-configs: - - group: 'default' - display-name: '测试模块' + - group: 'system' + display-name: '系统模块' paths-to-match: '/**' - packages-to-scan: com.ruoyi.web.controller.tool + packages-to-scan: com.ruoyi.web.controller.system + - group: 'core' + display-name: '业务模块' + paths-to-match: '/**' + packages-to-scan: com.ruoyi.system.controller + # 防止XSS攻击 xss: diff --git a/ruoyi-system/pom.xml b/ruoyi-system/pom.xml index 5439f13..a02fd17 100644 --- a/ruoyi-system/pom.xml +++ b/ruoyi-system/pom.xml @@ -23,6 +23,12 @@ ruoyi-common + + + org.springdoc + springdoc-openapi-starter-webmvc-ui + + \ No newline at end of file diff --git a/ruoyi-system/src/main/java/com/ruoyi/system/domain/SysConfig.java b/ruoyi-system/src/main/java/com/ruoyi/system/domain/SysConfig.java index f1af712..1d1aa77 100644 --- a/ruoyi-system/src/main/java/com/ruoyi/system/domain/SysConfig.java +++ b/ruoyi-system/src/main/java/com/ruoyi/system/domain/SysConfig.java @@ -1,5 +1,6 @@ package com.ruoyi.system.domain; +import io.swagger.v3.oas.annotations.media.Schema; import jakarta.validation.constraints.NotBlank; import jakarta.validation.constraints.Size; import org.apache.commons.lang3.builder.ToStringBuilder; @@ -13,11 +14,13 @@ import com.ruoyi.common.core.domain.BaseEntity; * * @author ruoyi */ +@Schema(description = "配置实体") public class SysConfig extends BaseEntity { private static final long serialVersionUID = 1L; /** 参数主键 */ + @Schema(description = "配置ID") @Excel(name = "参数主键", cellType = ColumnType.NUMERIC) private Long configId;