swagger优化

huliguo

2025-05-30 ac89371643d184cae09b2f93af2e1fce401dc92f

swagger优化

 pt-admin/src/main/java/com/ruoyi/web/controller/common/CaptchaController.java

@@ -46,7 +46,7 @@
    /**
     * 生成验证码
     */
    @ApiOperation(value = "获取图片验证码", notes = "获取验证码")
  /*  @ApiOperation(value = "获取图片验证码", notes = "获取验证码")
    @GetMapping("/captchaImage")
    public AjaxResult getCode(HttpServletResponse response) throws IOException {
        AjaxResult ajax = AjaxResult.success();
@@ -87,5 +87,5 @@
        ajax.put("uuid", uuid);
        ajax.put("img", "data:image/jpg;base64,"+Base64.encode(os.toByteArray()));
        return ajax;
    }
    }*/
}

 pt-admin/src/main/java/com/ruoyi/web/controller/common/CommonController.java

@@ -67,7 +67,7 @@
    /**
     * 通用上传请求（多个）
     */
    @ApiOperation(value = "文件上传（多个）", notes = "文件上传（多个）")
    /*@ApiOperation(value = "文件上传（多个）", notes = "文件上传（多个）")
    @PostMapping("/uploads")
    public AjaxResult uploadFiles(List<MultipartFile> files) throws Exception {
        try {
@@ -95,7 +95,7 @@
        } catch (Exception e) {
            return AjaxResult.error(e.getMessage());
        }
    }
    }*/

//    /**
//     * 本地资源通用下载

 pt-admin/src/main/java/com/ruoyi/web/controller/errand/AddressBookController.java

@@ -18,7 +18,6 @@
@Validated
@RestController
@RequestMapping(value = "/app/addressBook")
@Api(value = "用户地址簿", tags = "用户地址簿操作控制器")
@Slf4j
public class AddressBookController {
    @Autowired

 pt-admin/src/main/java/com/ruoyi/web/controller/errand/AgreementController.java

@@ -16,7 +16,6 @@

@RestController
@RequestMapping(value = "/app/agreement")
@Api(value = "协议", tags = "协议操作控制器")
@Slf4j
public class AgreementController {


 pt-admin/src/main/java/com/ruoyi/web/controller/errand/AppUserController.java

@@ -36,7 +36,6 @@

@RestController
@RequestMapping(value = "/app/user")
@Api(value = "app用户",tags = "app用户操作控制器")
@Slf4j
public class AppUserController {

@@ -45,12 +44,12 @@

    @Autowired
    private TokenBlacklistService blacklistService;
    @GetMapping("/test")
   /* @GetMapping("/test")
    @ApiOperation(value = "登出" ,tags = "app用户端")
    public R<Void> test(@RequestHeader("Authorization") String token) {
        throw new ServiceException("测试");

    }
    }*/
    /**
     * 登出
     */
@@ -76,7 +75,7 @@
     * 手机号验证码登录
     */
    @PostMapping("/mobileLogin")
    @ApiOperation(value = "手机号登录",tags = "app用户端")
    @ApiOperation(value = "手机号登录",tags = "app用户端",notes = "手机号：19923261698  如果不存在，即帮忙注册，需要传jscode")
    public R<LoginVO> mobileLogin(@RequestBody @Valid MobileLoginDTO mobileLogin) {
        return appUserService.mobileLogin(mobileLogin);


 pt-admin/src/main/java/com/ruoyi/web/controller/errand/BannerController.java

@@ -26,7 +26,6 @@
@Validated
@RestController
@RequestMapping(value = "/app/banner")
@Api(value = "banner", tags = "banner操作控制器")
@Slf4j
public class BannerController {


 pt-admin/src/main/java/com/ruoyi/web/controller/errand/CommunityController.java

@@ -21,7 +21,6 @@

@RestController
@RequestMapping(value = "/app/community")
@Api(value = "小区信息", tags = "小区信息操作控制器")
@Slf4j
public class CommunityController {
    @Autowired

 pt-admin/src/main/java/com/ruoyi/web/controller/errand/CommunityCourierController.java

@@ -11,7 +11,6 @@
@Validated
@RestController
@RequestMapping(value = "/communityCourier")
@Api(value = "小区 - 跑腿员关联", tags = "小区 - 跑腿员关联操作控制器")
@Slf4j
public class CommunityCourierController {
    @Autowired

 pt-admin/src/main/java/com/ruoyi/web/controller/errand/CourierController.java

@@ -25,7 +25,6 @@

@RestController
@RequestMapping(value = "/app/courier")
@Api(value = "跑腿员信息", tags = "跑腿员信息操作控制器")
@Slf4j
public class CourierController {
    @Autowired

 pt-admin/src/main/java/com/ruoyi/web/controller/errand/EvaluationController.java

@@ -18,7 +18,6 @@
@Validated
@RestController
@RequestMapping(value = "/app/evaluation")
@Api(value = "评价表", tags = "评价表操作控制器")
@Slf4j
public class EvaluationController {
    @Autowired

 pt-admin/src/main/java/com/ruoyi/web/controller/errand/FeedbackController.java

@@ -21,7 +21,6 @@
@Validated
@RestController
@RequestMapping(value = "/app/feedback")
@Api(value = "用户反馈", tags = "用户反馈操作控制器")
@Slf4j
public class FeedbackController {
    @Autowired

 pt-admin/src/main/java/com/ruoyi/web/controller/errand/OrderController.java

@@ -39,7 +39,7 @@

@RestController
@RequestMapping(value = "/app/order")
@Api(value = "订单表", tags = "订单表操作控制器")

@Slf4j
public class OrderController {
    @Autowired

 pt-admin/src/main/java/com/ruoyi/web/controller/errand/PhoneController.java

@@ -14,7 +14,7 @@
@Validated
@RestController
@RequestMapping(value = "/app/phone")
@Api(value = "客服电话", tags = "客服电话操作控制器")

@Slf4j
public class PhoneController {
    @Autowired

 pt-admin/src/main/java/com/ruoyi/web/controller/errand/RegionController.java

@@ -18,7 +18,7 @@
@Validated
@RestController
@RequestMapping(value = "/app/region")
@Api(value = "省市区三级联动", tags = "省市区三级联动操作控制器")

@Slf4j
public class RegionController {
    @Autowired

 pt-admin/src/main/java/com/ruoyi/web/controller/errand/ReportController.java

@@ -22,7 +22,7 @@
@Validated
@RestController
@RequestMapping(value = "/app/report")
@Api(value = "上报表", tags = "上报表操作控制器")

@Slf4j
public class ReportController {


 pt-admin/src/main/java/com/ruoyi/web/controller/errand/SystemConfigController.java

@@ -20,7 +20,7 @@
@Validated
@RestController
@RequestMapping(value = "/app/systemConfig")
@Api(value = "系统配置", tags = "系统配置操作控制器")

@Slf4j
public class SystemConfigController {


 pt-admin/src/main/java/com/ruoyi/web/controller/errand/UserCancellationLogController.java

@@ -11,7 +11,7 @@
@Validated
@RestController
@RequestMapping(value = "/userCancellationLog")
@Api(value = "注销记录", tags = "注销记录操作控制器")

@Slf4j
public class UserCancellationLogController {
    @Autowired

 pt-admin/src/main/java/com/ruoyi/web/controller/errand/VipOrderController.java

@@ -18,7 +18,7 @@

@RestController
@RequestMapping(value = "/app/vipOrder")
@Api(value = "vip订单信息", tags = "vip订单信息操作控制器")

@Slf4j
public class VipOrderController {
    @Autowired

 pt-admin/src/main/java/com/ruoyi/web/controller/errand/VipSettingController.java

@@ -20,7 +20,7 @@
@Validated
@RestController
@RequestMapping(value = "/app/vipSetting")
@Api(value = "会员权益", tags = "会员权益操作控制器")

@Slf4j
public class VipSettingController {
    @Autowired

 pt-admin/src/main/java/com/ruoyi/web/controller/system/SysDeptController.java

@@ -50,7 +50,7 @@
    }

    @PreAuthorize("@ss.hasPermi('system:user:list')")
    @ApiOperation(value = "用户管理-部门选择框", tags = "系统后台-权限管理")
    @ApiOperation(value = "账号管理-部门选择框", tags = "系统后台-权限管理")
    @GetMapping("/list")
    public AjaxResult list() {
        List<SysDeptPageVO> list = deptService.getDeptList();
@@ -101,11 +101,21 @@
    }

    /**
     * 部门详情
     */
    @PreAuthorize("@ss.hasPermi('system:dept:list')")
    @ApiOperation(value = "部门管理-查看部门（回显）", tags = "系统后台-权限管理")
    @GetMapping("/{deptId}")
    public AjaxResult detail(@PathVariable("deptId") Long deptId) {
        SysDept sysDept = deptService.selectDeptById(deptId);
        return success(sysDept);
    }
    /**
     * 修改部门
     */
    @PreAuthorize("@ss.hasPermi('system:dept:list')")
    @Log(title = "部门管理", businessType = BusinessType.UPDATE)
    @ApiOperation(value = "部门管理-新增部门", tags = "系统后台-权限管理")
    @ApiOperation(value = "部门管理-修改部门", tags = "系统后台-权限管理")
    @PutMapping("/edit")
    public AjaxResult edit(@RequestParam("id")Long id,
                           @RequestParam("name")String name) {

 pt-admin/src/main/java/com/ruoyi/web/controller/system/SysLoginController.java

@@ -50,7 +50,7 @@
     * @param loginBody 登录信息
     * @return 结果
     */
    @ApiOperation(value = "登录", notes = "登录")
    @ApiOperation(value = "登录", notes = "username：hlg password：e10adc3949ba59abbe56e057f20f883e（123456）  密码前端需MD5加密传输")
    @PostMapping("/login")
    public AjaxResult login(@RequestBody LoginBody loginBody) {
        AjaxResult ajax = AjaxResult.success();
@@ -99,13 +99,13 @@
     *
     * @return 路由信息
     */
    @ApiOperation(value = "获取路由信息", notes = "获取路由信息")
/*    @ApiOperation(value = "获取路由信息", notes = "获取路由信息")
    @GetMapping("getRouters")
    public AjaxResult getRouters() {
        Long userId = SecurityUtils.getUserId();
        List<SysMenu> menus = menuService.selectMenuTreeByUserId(userId);
        return AjaxResult.success(menuService.buildMenus(menus));
    }
    }*/

    /**
     * 退出登录

 pt-admin/src/main/java/com/ruoyi/web/controller/system/SysMenuController.java

@@ -28,7 +28,7 @@
/**
 * 菜单信息
 * */
@Api(value = "菜单控制器",tags = "菜单控制器")

@RestController
@RequestMapping("/system/menu")
public class SysMenuController extends BaseController {
@@ -38,7 +38,7 @@
     * 获取菜单列表树
     */
    @GetMapping("/tree")
    @ApiOperation(value = "角色管理-菜单列表树", tags = {"系统后台-权限管理","首页"})
    @ApiOperation(value = "角色管理-菜单列表树", tags = {"系统后台-权限管理","系统后台-首页"})
    public R<List<MenuTreeVO>> tree() {
        LoginUser loginUser = (LoginUser) SecurityContextHolder.getContext().getAuthentication().getPrincipal();
        return R.ok(menuService.tree(loginUser.getUserId()));

 pt-admin/src/main/java/com/ruoyi/web/controller/system/SysRoleController.java

@@ -43,7 +43,6 @@
 * 
 * @author ruoyi
 */
@Api(value = "角色管理控制器",tags = "角色管理控制器")
@RestController
@RequestMapping("/system/role")
public class SysRoleController extends BaseController {
@@ -125,7 +124,7 @@
        return toAjax(roleService.insertRole(role));

    }*/
    @ApiOperation(value = "新增角色", notes = "系统后台-权限管理")
    @ApiOperation(value = "新增角色", tags = "系统后台-权限管理")
    @PreAuthorize("@ss.hasPermi('system:role:list')")
    @Log(title = "角色管理", businessType = BusinessType.INSERT)
    @PostMapping("/add")
@@ -138,7 +137,7 @@
    /**
     * 修改保存角色
     */
    @ApiOperation(value = "修改角色", notes = "系统后台-权限管理")
    @ApiOperation(value = "修改角色", tags = "系统后台-权限管理")
    @PreAuthorize("@ss.hasPermi('system:role:list')")
    @Log(title = "角色管理", businessType = BusinessType.INSERT)
    @PutMapping("/edit")
@@ -209,7 +208,7 @@
    /**
     * 删除角色
     */
    @ApiOperation(value = "删除角色", notes = "系统后台-权限管理")
    @ApiOperation(value = "删除角色", tags = "系统后台-权限管理")
    @PreAuthorize("@ss.hasPermi('system:role:list')")
    @Log(title = "角色管理", businessType = BusinessType.DELETE)
    @DeleteMapping("/{roleId}")
@@ -220,7 +219,7 @@
    /**
     * 查看详情
     */
    @ApiOperation(value = "查看详情", notes = "系统后台-权限管理")
    @ApiOperation(value = "查看详情", tags = "系统后台-权限管理")
    @PreAuthorize("@ss.hasPermi('system:role:list')")
    @Log(title = "角色管理", businessType = BusinessType.DELETE)
    @GetMapping("/{roleId}")
@@ -233,14 +232,12 @@
    /**
     * 获取角色选择框列表
     */
/*
    @ApiOperation(value = "获取角色选择框列表", notes = "获取角色选择框列表")
    @PreAuthorize("@ss.hasPermi('system:role:query')")
    @GetMapping("/optionselect")
    public AjaxResult optionselect() {
        return success(roleService.selectRoleAll());
    @ApiOperation(value = "账号管理-获取角色下拉框", tags = "系统后台-权限管理")
    @PreAuthorize("@ss.hasPermi('system:user:list')")
    @GetMapping("/getOptionSelect")
    public R<List<SysRoleVO>> getOptionSelect() {
        return R.ok(roleService.getOptionSelect());
    }
*/

    /**
     * 查询已分配用户角色列表

 pt-admin/src/main/java/com/ruoyi/web/controller/system/SysUserController.java

@@ -131,7 +131,7 @@
     */
    @ApiOperation(value = "账号管理-修改用户", tags = "系统后台-权限管理")
    @PreAuthorize("@ss.hasPermi('system:user:list')")
    @Log(title = "用户管理", businessType = BusinessType.UPDATE)
    @Log(title = "账号管理", businessType = BusinessType.UPDATE)
    @PostMapping("/edit")
    public R<Void> edit(@Valid @RequestBody EditSysUserDTO dto) {
        userService.edit(dto);
@@ -162,7 +162,7 @@
     */
    @ApiOperation(value = "账号管理-删除用户", tags = "系统后台-权限管理")
    @PreAuthorize("@ss.hasPermi('system:user:list')")
    @Log(title = "用户管理", businessType = BusinessType.DELETE)
    @Log(title = "账号管理", businessType = BusinessType.DELETE)
    @DeleteMapping("/{userId}")
    public R remove(@PathVariable("userId") Long userId) {
        if (Objects.equals(userId, getUserId())) {
@@ -176,7 +176,7 @@
     */
    @ApiOperation(value = "账号管理-重置密码", tags = "系统后台-权限管理")
    @PreAuthorize("@ss.hasPermi('system:user:list')")
    @Log(title = "用户管理", businessType = BusinessType.UPDATE)
    @Log(title = "账号管理", businessType = BusinessType.UPDATE)
    @PutMapping("/resetPassword/{userId}")
    public R<Void> resetPassword(@PathVariable("userId") Long userId) {
        userService.resetPassword(userId);
@@ -188,11 +188,11 @@
     */
    @ApiOperation(value = "账号管理-状态修改", tags = "系统后台-权限管理")
    @PreAuthorize("@ss.hasPermi('system:user:list')")
    @Log(title = "用户管理", businessType = BusinessType.UPDATE)
    @Log(title = "账号管理", businessType = BusinessType.UPDATE)
    @PutMapping("/changeStatus/{userId}")
    public R<Void> changeStatus(@PathVariable("userId") Long userId) {
        if (Objects.equals(userId, getUserId())) {
            return R.fail("当前用户不能删除");
            return R.fail("当前用户不能操作");
        }
        userService.changeStatus(userId);
        return R.ok();

 pt-admin/src/main/resources/application.yml

@@ -16,7 +16,7 @@
# 开发环境配置
server:
  # 服务器的HTTP端口，默认为8080
  port: 8081
  port: 8084
  servlet:
    # 应用的访问路径
    context-path: /

 pt-system/src/main/java/com/ruoyi/system/mapper/SysDeptMapper.java

@@ -117,7 +117,7 @@
     * @param deptId 部门ID
     * @return 结果
     */
    public int deleteDeptById(Long deptId);
    public int deleteDeptById(@Param("deptId")Long deptId);

    IPage<SysDeptPageVO> page(@Param("page")IPage<SysDeptPageVO> page, @Param("name")String name);


 pt-system/src/main/java/com/ruoyi/system/mapper/SysRoleMapper.java

@@ -5,6 +5,7 @@
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.ruoyi.common.core.domain.entity.SysRole;
import com.ruoyi.system.object.vo.SysRolePageVO;
import com.ruoyi.system.object.vo.SysRoleVO;
import org.apache.ibatis.annotations.Param;

/**
@@ -109,6 +110,7 @@
     */
    public int deleteRoleByIds(Long[] roleIds);

    IPage<SysRolePageVO> page(IPage<SysRolePageVO> page, String name);
    IPage<SysRolePageVO> page(@Param("page") IPage<SysRolePageVO> page,@Param("name") String name);

    List<SysRoleVO> getOptionSelect();
}

 pt-system/src/main/java/com/ruoyi/system/object/dto/AddSysRoleDTO.java

@@ -4,13 +4,16 @@
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import javax.validation.constraints.NotEmpty;
import java.util.List;

@Data
@ApiModel("添加角色DTO")
public class AddSysRoleDTO {
    @ApiModelProperty("角色名称")
    @NotEmpty(message = "角色名称不能为空")
    private String roleName;
    @ApiModelProperty("菜单权限集合")
    @NotEmpty(message = "菜单权限集合不能为空")
    private List<Long> menuIds;
}

 pt-system/src/main/java/com/ruoyi/system/object/dto/AddSysUserDTO.java

@@ -4,16 +4,24 @@
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;

@Data
@ApiModel("添加用户DTO")
public class AddSysUserDTO{
    @ApiModelProperty(value = "姓名")
    @NotEmpty(message = "姓名不能为空")
    private String nickName;
    @ApiModelProperty(value = "联系电话")
    @NotEmpty(message = "联系电话不能为空")
    private String phonenumber;
    @ApiModelProperty(value = "所在部门id")
    @NotNull(message = "所在部门不能为空")
    private Long deptId;
    @ApiModelProperty(value = "所属角色id")
    @NotNull(message = "所属角色不能为空")
    private Long roleId;


}

 pt-system/src/main/java/com/ruoyi/system/object/vo/EditSysUserDTO.java

@@ -6,10 +6,13 @@
import lombok.Getter;
import lombok.Setter;

import javax.validation.constraints.NotNull;

@Getter
@Setter
@ApiModel("编辑用户DTO")
public class EditSysUserDTO extends AddSysUserDTO {
    @ApiModelProperty(value = "用户id")
    @NotNull(message = "用户id不能为空")
    private Long userId;
}

 pt-system/src/main/java/com/ruoyi/system/object/vo/SysDeptPageVO.java

@@ -13,5 +13,5 @@
    private Long deptId;

    @ApiModelProperty("部门名称")
    private String name;
    private String deptName;
}

 pt-system/src/main/java/com/ruoyi/system/service/ISysRoleService.java

@@ -186,4 +186,6 @@
    void edit( EditSysRoleDTO dto);

    SysRoleVO getById(Long roleId);

    List<SysRoleVO> getOptionSelect();
}

 pt-system/src/main/java/com/ruoyi/system/service/impl/SysRoleServiceImpl.java

@@ -1,11 +1,7 @@
package com.ruoyi.system.service.impl;

import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.*;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.ruoyi.common.core.domain.model.LoginUser;
@@ -495,4 +491,10 @@
        sysRoleVO.setMenuIdList(menuIds);
        return sysRoleVO;
    }

    @Override
    public List<SysRoleVO> getOptionSelect() {
        return roleMapper.getOptionSelect();

    }
}

 pt-system/src/main/resources/mapper/system/SysDeptMapper.xml

@@ -62,7 +62,7 @@
        select d.dept_id, d.parent_id, d.ancestors, d.dept_name, d.order_num, d.leader, d.phone, d.email, d.status,
            (select dept_name from sys_dept where dept_id = d.parent_id) parent_name
        from sys_dept d
        where d.dept_id = #{deptId}
        where d.dept_id = #{deptId} and del_flag = '0'
    </select>
    
    <select id="checkDeptExistUser" parameterType="Long" resultType="int">
@@ -88,21 +88,24 @@
    </select>
    <select id="page" resultType="com.ruoyi.system.object.vo.SysDeptPageVO">
        select
            dept_id,name
            dept_id,dept_name
        from sys_dept
        where
            del_flag='0'
        <if test="name!=null and name!='' ">
            and `dept_name` like concat('%',#{name},'%')
        </if>
    </select>
    <select id="getDeptList" resultType="com.ruoyi.system.object.vo.SysDeptPageVO">
        select
            dept_id,name
            dept_id,dept_name
        from sys_dept
        where
            del_flag='0'

    </select>
    <select id="selectDeptByName" resultType="com.ruoyi.common.core.domain.entity.SysDept">
        select dept_id from sys_dept where del_flag='0' and deptName like #{name}
        select dept_id from sys_dept where del_flag='0' and dept_name like #{name}
    </select>

    <insert id="insertDept" parameterType="SysDept">

 pt-system/src/main/resources/mapper/system/SysRoleMapper.xml

@@ -99,6 +99,9 @@
        </if>
        order by role_sort asc
    </select>
    <select id="getOptionSelect" resultType="com.ruoyi.system.object.vo.SysRoleVO">
        select role_id,role_name from sys_role where del_flag=0
    </select>


    <insert id="insertRole" parameterType="SysRole" useGeneratedKeys="true" keyProperty="roleId">