zhengsl/stdproject
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: 新增swagger注解

Browse Source 
给系统控制层操作的接口加上中文注解
This commit is contained in:
weitang 2025-07-14 10:35:04 +08:00
parent c0a64d9ac8
commit 360d05d535
12 changed files with 130 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
backend/src/main/java/com/stdproject/ProjectApplication.java
View File

@ -24,8 +24,8 @@ public class ProjectApplication {
SpringApplication.run(ProjectApplication.class, args);
System.out.println("\n========================================");
System.out.println(" StdProject 应用启动成功！");
System.out.println(" 接口文档地址: http://localhost:8080/swagger-ui.html");
System.out.println(" 应用端口: 8080");
System.out.println(" 接口文档地址: http://localhost:8083/swagger-ui.html");
System.out.println(" 应用端口: 8083");
System.out.println("========================================\n");
}

3
backend/src/main/java/com/stdproject/controller/DataVisualizationController.java
View File

@ -12,6 +12,7 @@ import io.gisbi.exception.DEException;
import io.gisbi.extensions.view.dto.ChartViewDTO;
import io.gisbi.result.ResultCode;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.annotation.Resource;
import org.apache.commons.lang3.exception.ExceptionUtils;
import org.springframework.util.CollectionUtils;
@ -26,6 +27,7 @@ import java.util.stream.Collectors;
@RestController
@RequestMapping("/dataVisualization")
@Tag(name = "可视化大屏信息表", description = "提供对可视化大屏信息表数据的增删改查操作")
public class DataVisualizationController {
@Resource
@ -33,7 +35,6 @@ public class DataVisualizationController {
@Resource
private ChartViewManege chartViewManege;
@Operation(summary = "根据视图ID查询模块数据")
@OperationLog(type = "01", module = "数据可视化", description = "根据ID查询数据看板")
@PostMapping("findById")
public ResponseResult findById(@RequestBody DataVisualizationBaseRequest request) {
Long dvId = request.getId();

14
backend/src/main/java/com/stdproject/controller/MenuController.java
View File

@ -2,11 +2,14 @@ package com.stdproject.controller;
import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
import com.stdproject.common.OperationLog;
import com.stdproject.config.ResponseResult;
import com.stdproject.entity.Menu;
import com.stdproject.service.IMenuService;
import com.stdproject.utils.AuthUtils;
import io.micrometer.common.util.StringUtils;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.annotation.Resource;
import org.springframework.web.bind.annotation.*;
@ -25,6 +28,7 @@ import java.util.Map;
*/
@RestController
@RequestMapping("/menuInterface")
@Tag(name = "菜单及按钮", description = "提供对菜单及按钮数据的增删改查操作")
public class MenuController {
@Resource
@ -36,6 +40,8 @@ public class MenuController {
* sysMenu 菜单表对象
* 返回值说明: 是否添加成功提示
***********************************/
@Operation(summary = "新增菜单及按钮")
@OperationLog(type = "01", module = "菜单及按钮", description = "新增菜单及按钮")
@PostMapping("/addMenu")
@ResponseBody
public ResponseResult addMenu(@RequestBody Menu menu) {
@ -53,6 +59,8 @@ public class MenuController {
* sysMenu 菜单或按钮表对象
* 返回值说明: 是否修改成功提示
***********************************/
@Operation(summary = "修改菜单及按钮根据ID")
@OperationLog(type = "02", module = "菜单及按钮", description = "修改菜单及按钮根据ID")
@PostMapping("/updateMenuById")
@ResponseBody
public ResponseResult updateById(@RequestBody Menu menu) {
@ -109,6 +117,8 @@ public class MenuController {
* id 删除列的id
* 返回值说明: 是否删除成功
***********************************/
@Operation(summary = "根据id删除菜单或按钮")
@OperationLog(type = "03", module = "菜单及按钮", description = "根据id删除菜单或按钮")
@PostMapping("/deleteMenuById")
@ResponseBody
public ResponseResult deleteMenuById(@RequestParam String id) {
@ -127,6 +137,8 @@ public class MenuController {
* isdisplay 是否有效字段
* 返回值说明: 是否更新成功
***********************************/
@Operation(summary = "更新菜单及按钮是否有效")
@OperationLog(type = "02", module = "菜单及按钮", description = "更新菜单及按钮是否有效")
@PostMapping("/setIsDisplay")
@ResponseBody
public ResponseResult setIsDisplay(String id, String isdisplay) {
@ -151,6 +163,8 @@ public class MenuController {
* moduleId 关联模块ID
* 返回值说明: 是否更新成功
***********************************/
@Operation(summary = "更新关联模块ID")
@OperationLog(type = "02", module = "菜单及按钮", description = "更新关联模块ID")
@PostMapping("/setModuleId")
@ResponseBody
public ResponseResult setModuleId(String id, String moduleId) {

18
backend/src/main/java/com/stdproject/controller/ModuleController.java
View File

@ -2,9 +2,12 @@ package com.stdproject.controller;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.stdproject.common.OperationLog;
import com.stdproject.config.ResponseResult;
import com.stdproject.entity.Module;
import com.stdproject.service.IModuleService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.annotation.Resource;
import org.springframework.web.bind.annotation.*;
@ -22,12 +25,17 @@ import java.util.Map;
*/
@RestController
@RequestMapping("/module")
@Tag(name = "系统模块", description = "提供对系统模块数据的增删改查操作")
public class ModuleController {
// 添加Service注入
@Resource
private IModuleService moduleService;
// 分页查询模块列表
/***********************************
* 用途说明: 分页查询模块列表
* 参数说明 appId 应用id
* 返回值说明: com.stdproject.config.ResponseResult
***********************************/
@GetMapping("/list")
public ResponseResult page(@RequestParam String appId) {
QueryWrapper<Module> wrapper = new QueryWrapper<>();
@ -37,7 +45,13 @@ public class ModuleController {
return ResponseResult.successData(list);
}
// 删除模块
/***********************************
* 用途说明: 删除模块
* 参数说明 id 模块id
* 返回值说明: com.stdproject.config.ResponseResult
***********************************/
@Operation(summary = "删除模块")
@OperationLog(type = "03", module = "系统模块", description = "删除模块")
@DeleteMapping("/{id}")
public ResponseResult remove(@PathVariable String id) {
return ResponseResult.successData(moduleService.removeById(id));

12
backend/src/main/java/com/stdproject/controller/OrganizationController.java
View File

@ -3,10 +3,13 @@ package com.stdproject.controller;
import cn.hutool.core.util.StrUtil;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
import com.stdproject.common.OperationLog;
import com.stdproject.config.ResponseResult;
import com.stdproject.entity.Organization;
import com.stdproject.service.IOrganizationService;
import com.stdproject.utils.AuthUtils;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.annotation.Resource;
import org.springframework.web.bind.annotation.*;
@ -25,6 +28,7 @@ import java.util.stream.Collectors;
*/
@RestController
@RequestMapping("/organization")
@Tag(name = "用户组织", description = "提供对用户组织数据的增删改查操作")
public class OrganizationController {
@Resource
@ -37,6 +41,8 @@ public class OrganizationController {
* organization 系统组织框架对象
* 返回值说明: 是否新增成功
***********************************/
@Operation(summary = "新增系统组织框架")
@OperationLog(type = "01", module = "用户组织", description = "新增系统组织框架")
@PostMapping("/addOrganization")
@ResponseBody
public ResponseResult addOrganization(@RequestBody Organization organization) {
@ -58,6 +64,8 @@ public class OrganizationController {
* organization 系统组织框架对象
* 返回值说明: 是否修改成功
***********************************/
@Operation(summary = "修改系统组织框架")
@OperationLog(type = "02", module = "用户组织", description = "修改系统组织框架")
@PostMapping("/updateOrganizationById")
@ResponseBody
public ResponseResult updateOrganizationById(@RequestBody Organization organization) {
@ -139,6 +147,8 @@ public class OrganizationController {
* sysOrganization 系统组织框架对象
* 返回值说明: 是否修改成功
***********************************/
@Operation(summary = "设置组织是否有效")
@OperationLog(type = "02", module = "用户组织", description = "设置组织是否有效")
@PostMapping("/setIsValid")
@ResponseBody
public ResponseResult setIsValid(@RequestParam String id, @RequestParam String isvaild) {
@ -170,6 +180,8 @@ public class OrganizationController {
* id 系统组织框架id
* 返回值说明: 是否删除成功
***********************************/
@Operation(summary = "根据id删除系统组织框架")
@OperationLog(type = "03", module = "用户组织", description = "根据id删除系统组织框架")
@DeleteMapping("/deleteById")
@ResponseBody
public ResponseResult deleteById(@RequestParam String id) {

23
backend/src/main/java/com/stdproject/controller/RoleController.java
View File

@ -3,12 +3,15 @@ package com.stdproject.controller;
import cn.hutool.core.util.StrUtil;
import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
import com.stdproject.common.OperationLog;
import com.stdproject.config.ResponseResult;
import com.stdproject.entity.Role;
import com.stdproject.service.IRoleService;
import com.stdproject.service.IUserService;
import com.stdproject.utils.AuthUtils;
import io.micrometer.common.util.StringUtils;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.annotation.Resource;
import org.springframework.web.bind.annotation.*;
@ -25,6 +28,7 @@ import java.util.List;
*/
@RestController
@RequestMapping("/role")
@Tag(name = "系统角色", description = "提供对系统角色数据的增删改查操作")
public class RoleController {
@Resource
@ -39,6 +43,8 @@ public class RoleController {
* sysRole 新增角色信息
* 返回值说明: 是否新增成功
***********************************/
@Operation(summary = "新增角色")
@OperationLog(type = "01", module = "系统角色", description = "新增角色")
@PostMapping("/addRole")
@ResponseBody
public ResponseResult addRole(@RequestBody Role role) {
@ -56,8 +62,11 @@ public class RoleController {
* role 角色对象
* 返回值说明: 是否修改成功
***********************************/
@Operation(summary = "更新角色信息")
@OperationLog(type = "02", module = "系统角色", description = "更新角色信息")
@PostMapping("/updateRole")
@ResponseBody
public ResponseResult updateRole(@RequestBody Role role) {
if (StrUtil.isBlank(role.getId())) {
return ResponseResult.error("需要提交角色ID！");
@ -82,6 +91,7 @@ public class RoleController {
* rolename 角色名称
* 返回值说明: 查询都有角色
***********************************/
@Operation(summary = "查询所有角色")
@PostMapping("/listRole")
@ResponseBody
public ResponseResult listRole(String appId, String rolename) {
@ -95,6 +105,7 @@ public class RoleController {
* id 角色表id
* 返回值说明: 根据id查询到角色详情
***********************************/
@Operation(summary = "根据Id获取单个角色")
@PostMapping("/getRoleById")
@ResponseBody
public ResponseResult getRoleById(String id) {
@ -109,6 +120,8 @@ public class RoleController {
* id 角色id
* 返回值说明: 是否删除成功
***********************************/
@Operation(summary = "根据id删除角色")
@OperationLog(type = "03", module = "系统角色", description = "根据id删除角色")
@PostMapping("/deleteRoleById")
@ResponseBody
public ResponseResult deleteRoleById(@RequestParam String id) {
@ -125,6 +138,8 @@ public class RoleController {
*ids 用户id集合
* 返回值说明: 判断是否删除成功
************************************/
@Operation(summary = "根据ID批量删除角色")
@OperationLog(type = "03", module = "系统角色", description = "根据ID批量删除角色")
@PostMapping("/deleteRoleByIds")
@ResponseBody
public ResponseResult deleteRoleByIds(String ids) {
@ -146,6 +161,8 @@ public class RoleController {
*isvaild 是否有效（1 是 0 否 ）
* 返回值说明: 是否新增成功
***********************************/
@Operation(summary = "设置角色是否有效")
@OperationLog(type = "02", module = "系统角色", description = "设置角色是否有效")
@PostMapping("/setIsvaild")
@ResponseBody
public ResponseResult setIsvaild(String id, String isvaild) {
@ -170,6 +187,8 @@ public class RoleController {
* menuIds 权限id字符串
* 返回值说明: 是否分配成功
***********************************/
@Operation(summary = "角色菜单权限")
@OperationLog(type = "02", module = "系统角色", description = "角色菜单权限")
@PostMapping("/setMenuByRoleId")
@ResponseBody
public ResponseResult setMenuByRoleId(String id, String menuIds) {
@ -196,6 +215,8 @@ public class RoleController {
* userids 用户id组
* 返回值说明: 是否新增成功
***********************************/
@Operation(summary = "角色添加用户")
@OperationLog(type = "01", module = "系统角色", description = "角色添加用户")
@PostMapping("/setRoleUsers")
@ResponseBody
public ResponseResult setRoleUsers(String roleid, String userids) {
@ -217,6 +238,8 @@ public class RoleController {
* roleid 角色id
* 返回值说明: 是否新增成功
***********************************/
@Operation(summary = "删除角色用户")
@OperationLog(type = "03", module = "系统角色", description = "删除角色用户")
@PostMapping("/deleteRoleUser")
@ResponseBody
public ResponseResult deleteRoleUsers(@RequestParam String roleid,

19
backend/src/main/java/com/stdproject/controller/UserController.java
View File

@ -3,6 +3,7 @@ package com.stdproject.controller;
import cn.hutool.core.util.StrUtil;
import cn.hutool.json.JSONUtil;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.stdproject.common.OperationLog;
import com.stdproject.config.ResponseResult;
import com.stdproject.config.WebConfig;
import com.stdproject.entity.AppOptLog;
@ -16,6 +17,8 @@ import com.stdproject.utils.RsaUtils;
import com.stdproject.utils.commonUtils;
import io.gisbi.utils.IPUtils;
import io.micrometer.common.util.StringUtils;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.annotation.Resource;
import jakarta.servlet.http.HttpServletRequest;
import org.springframework.beans.factory.annotation.Autowired;
@ -43,6 +46,7 @@ import java.util.Map;
*/
@RestController
@RequestMapping("/user")
@Tag(name = "系统用户", description = "提供对系统用户数据的增删改查操作")
public class UserController {
@Resource
@ -67,6 +71,8 @@ private Long jwtExpirationMs;
* roleids 角色ID
* 返回值说明: 是否新增成功
***********************************/
@Operation(summary = "新增系统用户")
@OperationLog(type = "01", module = "系统用户", description = "新增系统用户")
@PostMapping("/addUser")
@ResponseBody
public ResponseResult addUser(@RequestBody User user, String roleids) {
@ -81,6 +87,8 @@ private Long jwtExpirationMs;
* roleids 角色ID
* 返回值说明: 是否新增成功
***********************************/
@Operation(summary = "修改用户信息")
@OperationLog(type = "02", module = "系统用户", description = "修改用户信息")
@PostMapping("/updateUser")
@ResponseBody
public ResponseResult updateUser(@RequestBody User user, String roleids) {
@ -112,6 +120,8 @@ private Long jwtExpirationMs;
*id 用户id
* 返回值说明: 判断是否删除成功
************************************/
@Operation(summary = "根据ID删除用户")
@OperationLog(type = "03", module = "系统用户", description = "根据ID删除用户")
@PostMapping("/deleteUserById")
@ResponseBody
public ResponseResult deleteUserById(String id) {
@ -131,6 +141,8 @@ private Long jwtExpirationMs;
*ids 用户id集合
* 返回值说明: 判断是否删除成功
************************************/
@Operation(summary = "根据ID批量删除用户")
@OperationLog(type = "03", module = "系统用户", description = "根据ID批量删除用户")
@PostMapping("/deleteUserByIds")
@ResponseBody
public ResponseResult deleteUserByIds(String ids) {
@ -153,6 +165,8 @@ private Long jwtExpirationMs;
* status 设置状态
* 返回值说明: 判断是否设置成功
************************************/
@Operation(summary = "设置账号状态(管理员)")
@OperationLog(type = "02", module = "系统用户", description = "设置账号状态(管理员)")
@PostMapping("/setStatus")
@ResponseBody
public ResponseResult setStatus(@RequestParam String id, @RequestParam String status) {
@ -176,6 +190,8 @@ private Long jwtExpirationMs;
*id 重置密码的 用户id
* 返回值说明: 判断是否重置成功
************************************/
@Operation(summary = "重置用户密码(管理员)")
@OperationLog(type = "02", module = "系统用户", description = "重置用户密码(管理员)")
@PostMapping("/resetPassword")
@ResponseBody
public ResponseResult resetPassword(String id) throws Exception {
@ -190,6 +206,7 @@ private Long jwtExpirationMs;
}
}
@Operation(summary = "用户登录")
@PostMapping("/login")
@ResponseBody
public ResponseResult login(String username, String password) {
@ -256,6 +273,8 @@ private Long jwtExpirationMs;
return ResponseResult.error("认证失败：" + e.getMessage());
}
}
@Operation(summary = "用户退出登录")
@PostMapping("/logout")
@ResponseBody
public ResponseResult logout() {

4
backend/src/main/java/com/stdproject/controller/VisualizationLinkJumpController.java
View File

@ -12,6 +12,7 @@ import io.gisbi.constant.CommonConstants;
import io.gisbi.utils.AuthUtils;
import io.gisbi.utils.ModelUtils;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.annotation.Resource;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
@ -23,13 +24,14 @@ import java.util.stream.Collectors;
@RestController
@RequestMapping("/linkJump")
@Tag(name = "跳转记录表", description = "提供对跳转记录表数据的增删改查操作")
public class VisualizationLinkJumpController {
@Resource
private ExtVisualizationLinkJumpMapper extVisualizationLinkJumpMapper;
@Operation(summary = "根据可视化资源ID查询跳转信息")
@OperationLog(type = "01", module = "数据可视化", description = "根据可视化资源ID查询跳转信息")
@OperationLog(type = "06", module = "数据可视化", description = "根据可视化资源ID查询跳转信息")
@GetMapping("/queryVisualizationJumpInfo/{dvId}/{resourceTable}")
public ResponseResult queryVisualizationJumpInfo(@PathVariable Long dvId,@PathVariable String resourceTable) throws Exception {
Map<String, VisualizationLinkJumpInfoDTO> resultBase = new HashMap<>();

4
backend/src/main/java/com/stdproject/controller/VisualizationLinkageController.java
View File

@ -11,6 +11,7 @@ import io.gisbi.exception.DEException;
import io.gisbi.extensions.view.dto.ChartViewDTO;
import io.gisbi.result.ResultCode;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.annotation.Resource;
import org.apache.commons.lang3.exception.ExceptionUtils;
import org.springframework.web.bind.annotation.*;
@ -22,13 +23,14 @@ import java.util.stream.Collectors;
@RestController
@RequestMapping("/linkage")
@Tag(name = "联动记录表", description = "提供对联动记录表数据的增删改查操作")
public class VisualizationLinkageController {
@Resource
private ExtVisualizationLinkageMapper extVisualizationLinkageMapper;
@Operation(summary = "根据资源ID查询联动信息")
@OperationLog(type = "01", module = "数据可视化", description = "根据资源ID查询联动信息")
@OperationLog(type = "06", module = "数据可视化", description = "根据资源ID查询联动信息")
@GetMapping("/getVisualizationAllLinkageInfo/{dvId}/{resourceTable}")
public ResponseResult getVisualizationAllLinkageInfo(@PathVariable Long dvId,@PathVariable String resourceTable) throws Exception {
List<LinkageInfoDTO> info = null;

21
backend/src/main/java/com/stdproject/entity/vo/SettingItemVO.java Normal file
View File

@ -0,0 +1,21 @@
package com.stdproject.entity.vo;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
@Schema(description = "基础设置参数项")
@Data
@NoArgsConstructor
public class SettingItemVO implements Serializable {
@Schema(description = "键", requiredMode = Schema.RequiredMode.REQUIRED)
private String pkey;
@Schema(description = "值", requiredMode = Schema.RequiredMode.REQUIRED)
private String pval;
@Schema(description = "类型", requiredMode = Schema.RequiredMode.REQUIRED)
private String type;
@Schema(description = "顺序", requiredMode = Schema.RequiredMode.REQUIRED)
private Integer sort;
}

12
backend/src/main/java/com/stdproject/service/manage/SysParameterManage.java
View File

@ -2,6 +2,7 @@ package com.stdproject.service.manage;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.stdproject.entity.CoreSysSetting;
import com.stdproject.entity.vo.SettingItemVO;
import com.stdproject.mapper.CoreSysSettingMapper;
import com.stdproject.request.OnlineMapEditor;
import io.gisbi.utils.BeanUtils;
@ -13,10 +14,7 @@ import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.*;
import java.util.stream.Collectors;
@Component
@ -130,6 +128,12 @@ public class SysParameterManage {
}
public List<SettingItemVO> convert(List<CoreSysSetting> sysSettings) {
return sysSettings.stream().sorted(Comparator.comparing(CoreSysSetting::getSort)).map(item -> BeanUtils.copyBean(new SettingItemVO(), item)).toList();
}
public List<Object> getUiList() {
List<Object> result = new ArrayList<>();

2
backend/src/main/resources/application.yml
View File

@ -19,7 +19,7 @@ spring:
main:
allow-bean-definition-overriding: true
datasource:
url: ${DB_URL:jdbc:mysql://192.168.1.58:3306/gis_test?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai&useSSL=false&allowPublicKeyRetrieval=true}
url: ${DB_URL:jdbc:mysql://192.168.1.70:3306/gis_test?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai&useSSL=false&allowPublicKeyRetrieval=true}
username: ${DB_USERNAME:root}
password: ${DB_PASSWORD:123456}
driver-class-name: com.mysql.cj.jdbc.Driver