修改各模块ts接口规范

This commit is contained in:
lcj
2025-03-13 15:07:20 +08:00
parent db4742e606
commit 777f8f4c28
33 changed files with 189 additions and 126 deletions

View File

@ -186,9 +186,9 @@ springdoc:
api-docs:
# 是否开启接口文档
enabled: true
# swagger-ui:
# # 持久化认证数据
# persistAuthorization: true
# swagger-ui:
# # 持久化认证数据
# persistAuthorization: true
info:
# 标题
title: '标题:${ruoyi.name}多租户管理系统_接口文档'
@ -210,15 +210,19 @@ springdoc:
name: ${sa-token.token-name}
#这里定义了两个分组,可定义多个,也可以不定义
group-configs:
- group: 1.演示模块
packages-to-scan: org.dromara.demo
- group: 2.通用模块
- group: 1.通用模块
packages-to-scan: org.dromara.web
- group: 3.系统模块
- group: 2.系统模块
packages-to-scan: org.dromara.system
- group: 4.代码生成模块
- group: 3.项目模块
packages-to-scan: org.dromara.project
- group: 4.材料模块
packages-to-scan: org.dromara.materials
- group: 5.机械模块
packages-to-scan: org.dromara.machinery
- group: 6.代码生成模块
packages-to-scan: org.dromara.generator
- group: 5.工作流模块
- group: 7.工作流模块
packages-to-scan: org.dromara.workflow
# 防止XSS攻击

View File

@ -45,9 +45,8 @@ public class BusUserProjectRelevancyController extends BaseController {
private final IBusUserProjectRelevancyService userProjectRelevancyService;
/**
* 查询系统用户与项目关联列表
* 查询用户与项目关联列表
*/
@Tag(name = "查询用户与项目关联列表")
@SaCheckPermission("project:projectRelevancy:list")
@GetMapping("/list")
public R<Page<BusUserProjectRelevancyVo>> list(UserProjectRelevancyQueryReq req) {
@ -57,7 +56,6 @@ public class BusUserProjectRelevancyController extends BaseController {
/**
* 查询登录用户与项目关联列表
*/
@Tag(name = "查询登录用户与项目关联列表")
@SaCheckPermission("project:projectRelevancy:list")
@GetMapping("/login/list")
public R<List<LoginUserProjectRelevancyResp>> listByLoginUser() {
@ -68,7 +66,6 @@ public class BusUserProjectRelevancyController extends BaseController {
/**
* 查询登录用户与项目关联分页
*/
@Tag(name = "查询登录用户与项目关联分页")
@SaCheckPermission("project:projectRelevancy:list")
@GetMapping("/login/page")
public R<Page<BusUserProjectRelevancyVo>> pageByLoginUser(UserProjectRelevancyQueryReq req) {
@ -77,9 +74,8 @@ public class BusUserProjectRelevancyController extends BaseController {
}
/**
* 导出系统用户与项目关联列表
* 导出用户与项目关联列表
*/
@Tag(name = "导出用户与项目关联列表")
@SaCheckPermission("project:projectRelevancy:export")
@Log(title = "系统用户与项目关联", businessType = BusinessType.EXPORT)
@PostMapping("/export")
@ -89,11 +85,10 @@ public class BusUserProjectRelevancyController extends BaseController {
}
/**
* 获取系统用户与项目关联详细信息
* 获取用户与项目关联详细信息
*
* @param id 主键
*/
@Tag(name = "获取用户与项目关联详细信息")
@SaCheckPermission("project:projectRelevancy:query")
@GetMapping("/{id}")
public R<BusUserProjectRelevancyVo> getInfo(@NotNull(message = "主键不能为空")
@ -102,9 +97,8 @@ public class BusUserProjectRelevancyController extends BaseController {
}
/**
* 新增系统用户与项目关联
* 新增用户与项目关联
*/
@Tag(name = "新增用户与项目关联")
@SaCheckPermission("project:projectRelevancy:add")
@Log(title = "系统用户与项目关联", businessType = BusinessType.INSERT)
@RepeatSubmit()
@ -114,9 +108,8 @@ public class BusUserProjectRelevancyController extends BaseController {
}
/**
* 新增系统用户与项目列表关联
* 新增用户与项目列表关联
*/
@Tag(name = "新增用户与项目列表关联")
@SaCheckPermission("project:projectRelevancy:add")
@Log(title = "系统用户与项目关联", businessType = BusinessType.INSERT)
@RepeatSubmit()
@ -127,9 +120,8 @@ public class BusUserProjectRelevancyController extends BaseController {
}
/**
* 移除系统用户与项目列表关联
* 移除用户与项目列表关联
*/
@Tag(name = "移除用户与项目列表关联")
@SaCheckPermission("project:projectRelevancy:remove")
@Log(title = "系统用户与项目关联", businessType = BusinessType.INSERT)
@RepeatSubmit()
@ -152,9 +144,8 @@ public class BusUserProjectRelevancyController extends BaseController {
/**
* 修改系统用户与项目关联
* 修改用户与项目关联
*/
@Tag(name = "修改用户与项目关联")
@SaCheckPermission("project:projectRelevancy:edit")
@Log(title = "系统用户与项目关联", businessType = BusinessType.UPDATE)
@RepeatSubmit()
@ -164,11 +155,10 @@ public class BusUserProjectRelevancyController extends BaseController {
}
/**
* 删除系统用户与项目关联
* 删除用户与项目关联
*
* @param ids 主键串
*/
@Tag(name = "删除用户与项目关联")
@SaCheckPermission("project:projectRelevancy:remove")
@Log(title = "系统用户与项目关联", businessType = BusinessType.DELETE)
@DeleteMapping("/{ids}")