test-version22
/
MeterSphere
mirror of https://gitee.com/fit2cloud-feizhiyun/MeterSphere.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

build: Swagger Tag 信息统一规范

This commit is contained in:
fit2-zhao 2023-08-29 15:35:47 +08:00 committed by fit2-zhao
parent 7e31df10ca
commit 2d3e73a04d
8 changed files with 49 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
backend/services/system-setting/src/main/java/io/metersphere/system/controller/AuthSourceController.java
View File

@ -28,7 +28,7 @@ import org.springframework.web.bind.annotation.*;
import java.util.List;
@Tag(name = "系统设置-认证设置")
@Tag(name = "系统设置-系统-系统参数-认证设置")
@RestController
@RequestMapping("/system/authsource")
@Data
@ -40,7 +40,7 @@ public class AuthSourceController {
private LdapService ldapService;
@PostMapping("/list")
@Operation(summary = "系统设置-认证设置-列表查询")
@Operation(summary = "系统设置-系统-系统参数-认证设置-列表查询")
@RequiresPermissions(PermissionConstants.SYSTEM_PARAMETER_SETTING_AUTH_READ)
public Pager<List<AuthSource>> list(@Validated @RequestBody BasePageRequest request) {
Page<Object> page = PageHelper.startPage(request.getCurrent(), request.getPageSize(),
@ -49,7 +49,7 @@ public class AuthSourceController {
}
@PostMapping("/add")
@Operation(summary = "系统设置-认证设置-新增")
@Operation(summary = "系统设置-系统-系统参数-认证设置-新增")
@RequiresPermissions(PermissionConstants.SYSTEM_PARAMETER_SETTING_AUTH_READ_ADD)
@Log(type = OperationLogType.ADD, expression = "#msClass.addLog(#authSource)", msClass = AuthSourceLogService.class)
public AuthSource add(@Validated @RequestBody AuthSourceRequest authSource) {
@ -57,7 +57,7 @@ public class AuthSourceController {
}
@PostMapping("/update")
@Operation(summary = "系统设置-认证设置-更新")
@Operation(summary = "系统设置-系统-系统参数-认证设置-更新")
@RequiresPermissions(PermissionConstants.SYSTEM_PARAMETER_SETTING_AUTH_READ_UPDATE)
@Log(type = OperationLogType.UPDATE, expression = "#msClass.updateLog(#authSource)", msClass = AuthSourceLogService.class)
public AuthSourceRequest update(@Validated @RequestBody AuthSourceRequest authSource) {
@ -65,14 +65,14 @@ public class AuthSourceController {
}
@GetMapping("/get/{id}")
@Operation(summary = "系统设置-认证设置-详细信息")
@Operation(summary = "系统设置-系统-系统参数-认证设置-详细信息")
@RequiresPermissions(PermissionConstants.SYSTEM_PARAMETER_SETTING_AUTH_READ)
public AuthSourceDTO get(@PathVariable(value = "id") String id) {
return authSourceService.getAuthSource(id);
}
@GetMapping("/delete/{id}")
@Operation(summary = "系统设置-认证设置-删除")
@Operation(summary = "系统设置-系统-系统参数-认证设置-删除")
@RequiresPermissions(PermissionConstants.SYSTEM_PARAMETER_SETTING_AUTH_READ_DELETE)
@Log(type = OperationLogType.DELETE, expression = "#msClass.deleteLog(#id)", msClass = AuthSourceLogService.class)
public void delete(@PathVariable(value = "id") String id) {
@ -81,7 +81,7 @@ public class AuthSourceController {
@PostMapping("/update/status")
@Operation(summary = "系统设置-认证设置-更新状态")
@Operation(summary = "系统设置-系统-系统参数-认证设置-更新状态")
@RequiresPermissions(PermissionConstants.SYSTEM_PARAMETER_SETTING_AUTH_READ_UPDATE)
@Log(type = OperationLogType.UPDATE, expression = "#msClass.updateLog(#request.getId())", msClass = AuthSourceLogService.class)
public AuthSource updateStatus(@Validated @RequestBody AuthSourceStatusRequest request) {
@ -90,14 +90,14 @@ public class AuthSourceController {
@PostMapping("/ldap/test-connect")
@Operation(summary = "系统设置-认证设置-ldap测试连接")
@Operation(summary = "系统设置-系统-系统参数-认证设置-ldap测试连接")
@RequiresPermissions(PermissionConstants.SYSTEM_PARAMETER_SETTING_AUTH_READ_UPDATE)
public void ldapTestConnect(@Validated @RequestBody LdapRequest request) {
ldapService.testConnect(request);
}
@PostMapping("/ldap/test-login")
@Operation(summary = "系统设置-认证设置-ldap测试登录")
@Operation(summary = "系统设置-系统-系统参数-认证设置-ldap测试登录")
@RequiresPermissions(PermissionConstants.SYSTEM_PARAMETER_SETTING_AUTH_READ_UPDATE)
public void testLogin(@RequestBody LdapLoginRequest request) {
ldapService.testLogin(request);

14
backend/services/system-setting/src/main/java/io/metersphere/system/controller/GlobalUserRoleController.java
View File

@ -26,7 +26,7 @@ import java.util.List;
* @author : jianxing
* @date : 2023-6-9
*/
@Tag(name = "系统设置-用户组")
@Tag(name = "系统设置-系统-用户组")
@RestController
@RequestMapping("/user/role/global")
public class GlobalUserRoleController {
@ -35,21 +35,21 @@ public class GlobalUserRoleController {
private GlobalUserRoleService globalUserRoleService;
@GetMapping("/list")
@Operation(summary = "系统设置-用户组-获取全局用户组列表")
@Operation(summary = "系统设置-系统-用户组-获取全局用户组列表")
@RequiresPermissions(PermissionConstants.SYSTEM_USER_ROLE_READ)
public List<UserRole> list() {
return globalUserRoleService.list();
}
@GetMapping("/permission/setting/{id}")
@Operation(summary = "系统设置-用户组-获取全局用户组对应的权限配置")
@Operation(summary = "系统设置-系统-用户组-获取全局用户组对应的权限配置")
@RequiresPermissions(PermissionConstants.SYSTEM_USER_ROLE_READ)
public List<PermissionDefinitionItem> getPermissionSetting(@PathVariable String id) {
return globalUserRoleService.getPermissionSetting(id);
}
@PostMapping("/permission/update")
@Operation(summary = "系统设置-用户组-编辑全局用户组对应的权限配置")
@Operation(summary = "系统设置-系统-用户组-编辑全局用户组对应的权限配置")
@RequiresPermissions(PermissionConstants.SYSTEM_USER_ROLE_UPDATE)
@Log(type = OperationLogType.UPDATE, expression = "#msClass.updateLog(#request)", msClass = GlobalUserRoleLogService.class)
public void updatePermissionSetting(@Validated @RequestBody PermissionSettingUpdateRequest request) {
@ -57,7 +57,7 @@ public class GlobalUserRoleController {
}
@PostMapping("/add")
@Operation(summary = "系统设置-用户组-添加自定义全局用户组")
@Operation(summary = "系统设置-系统-用户组-添加自定义全局用户组")
@RequiresPermissions(PermissionConstants.SYSTEM_USER_ROLE_ADD)
@Log(type = OperationLogType.ADD, expression = "#msClass.addLog(#request)", msClass = GlobalUserRoleLogService.class)
public UserRole add(@Validated({Created.class}) @RequestBody UserRoleUpdateRequest request) {
@ -68,7 +68,7 @@ public class GlobalUserRoleController {
}
@PostMapping("/update")
@Operation(summary = "系统设置-用户组-更新自定义全局用户组")
@Operation(summary = "系统设置-系统-用户组-更新自定义全局用户组")
@RequiresPermissions(PermissionConstants.SYSTEM_USER_ROLE_UPDATE)
@Log(type = OperationLogType.UPDATE, expression = "#msClass.updateLog(#request)", msClass = GlobalUserRoleLogService.class)
public UserRole update(@Validated({Updated.class}) @RequestBody UserRoleUpdateRequest request) {
@ -78,7 +78,7 @@ public class GlobalUserRoleController {
}
@GetMapping("/delete/{id}")
@Operation(summary = "系统设置-用户组-删除自定义全局用户组")
@Operation(summary = "系统设置-系统-用户组-删除自定义全局用户组")
@RequiresPermissions(PermissionConstants.SYSTEM_USER_ROLE_DELETE)
@Log(type = OperationLogType.DELETE, expression = "#msClass.deleteLog(#id)", msClass = GlobalUserRoleLogService.class)
public void delete(@PathVariable String id) {

10
backend/services/system-setting/src/main/java/io/metersphere/system/controller/GlobalUserRoleRelationController.java
View File

@ -31,7 +31,7 @@ import java.util.List;
* @date : 2023-6-12
*/
@RestController
@Tag(name = "系统设置-用户组与用户关联关系")
@Tag(name = "系统设置-系统-用户组-用户关联关系")
@RequestMapping("/user/role/relation/global")
public class GlobalUserRoleRelationController {
@ -39,7 +39,7 @@ public class GlobalUserRoleRelationController {
private GlobalUserRoleRelationService globalUserRoleRelationService;
@PostMapping("/list")
@Operation(summary = "系统设置-用户组与用户关联关系-获取全局用户组对应的用户列表")
@Operation(summary = "系统设置-系统-用户组-用户关联关系-获取全局用户组对应的用户列表")
@RequiresPermissions(PermissionConstants.SYSTEM_USER_ROLE_READ)
public Pager<List<UserRoleRelationUserDTO>> list(@Validated @RequestBody GlobalUserRoleRelationQueryRequest request) {
Page<Object> page = PageHelper.startPage(request.getCurrent(), request.getPageSize(), true);
@ -47,7 +47,7 @@ public class GlobalUserRoleRelationController {
}
@PostMapping("/add")
@Operation(summary = "系统设置-用户组与用户关联关系-创建全局用户组和用户的关联关系")
@Operation(summary = "系统设置-系统-用户组-用户关联关系-创建全局用户组和用户的关联关系")
@RequiresPermissions(PermissionConstants.SYSTEM_USER_ROLE_UPDATE)
@Log(type = OperationLogType.ADD, expression = "#msClass.addLog(#request)", msClass = GlobalUserRoleRelationLogService.class)
public void add(@Validated({Created.class}) @RequestBody GlobalUserRoleRelationUpdateRequest request) {
@ -56,7 +56,7 @@ public class GlobalUserRoleRelationController {
}
@GetMapping("/delete/{id}")
@Operation(summary = "系统设置-用户组与用户关联关系-删除全局用户组和用户的关联关系")
@Operation(summary = "系统设置-系统-用户组-用户关联关系-删除全局用户组和用户的关联关系")
@RequiresPermissions(PermissionConstants.SYSTEM_USER_ROLE_UPDATE)
@Log(type = OperationLogType.DELETE, expression = "#msClass.deleteLog(#id)", msClass = GlobalUserRoleRelationLogService.class)
public void delete(@PathVariable String id) {
@ -64,7 +64,7 @@ public class GlobalUserRoleRelationController {
}
@GetMapping("/user/option/{roleId}")
@Operation(summary = "系统设置-用户组与用户关联关系-获取需要关联的用户选项")
@Operation(summary = "系统设置-系统-用户组-用户关联关系-获取需要关联的用户选项")
@RequiresPermissions(value = {PermissionConstants.SYSTEM_USER_ROLE_READ})
public List<ExcludeOptionDTO> getSelectOption(@Parameter(description = "用户组ID", schema = @Schema(requiredMode = Schema.RequiredMode.REQUIRED))
@PathVariable String roleId) {

6
backend/services/system-setting/src/main/java/io/metersphere/system/controller/OperationLogController.java
View File

@ -44,7 +44,7 @@ public class OperationLogController {
@GetMapping("/get/options")
@Operation(summary = "系统-日志-获取组织/项目级联下拉框选项")
@Operation(summary = "系统设置-系统-日志-获取组织/项目级联下拉框选项")
@RequiresPermissions(PermissionConstants.SYSTEM_LOG_READ)
public OrganizationProjectOptionsResponse getOptions() {
@ -62,7 +62,7 @@ public class OperationLogController {
@PostMapping("/list")
@Operation(summary = "系统-日志-系统操作日志列表查询")
@Operation(summary = "系统设置-系统-日志-系统操作日志列表查询")
@RequiresPermissions(PermissionConstants.SYSTEM_LOG_READ)
public Pager<List<OperationLogResponse>> list(@Validated @RequestBody OperationLogRequest request) {
Page<Object> page = PageHelper.startPage(request.getCurrent(), request.getPageSize(),
@ -72,7 +72,7 @@ public class OperationLogController {
@GetMapping("/user/list")
@Operation(summary = "系统-日志-系统日志页面，获取用户列表")
@Operation(summary = "系统设置-系统-日志-系统日志页面，获取用户列表")
@RequiresPermissions(PermissionConstants.SYSTEM_LOG_READ)
public List<User> getUserList() {
List<User> userList = userService.getUserList();

6
backend/services/system-setting/src/main/java/io/metersphere/system/controller/OrganizationLogController.java
View File

@ -47,7 +47,7 @@ public class OrganizationLogController {
@GetMapping("/get/options/{organizationId}")
@Operation(summary = "组织-日志-获取项目级联下拉框选项")
@Operation(summary = "系统设置-组织-日志-获取项目级联下拉框选项")
@RequiresPermissions(PermissionConstants.ORGANIZATION_LOG_READ)
public OrganizationProjectOptionsResponse getOrganizationOptions(@PathVariable(value = "organizationId") String organizationId) {
//获取全部项目
@ -60,7 +60,7 @@ public class OrganizationLogController {
@GetMapping("/user/list/{organizationId}")
@Operation(summary = "组织-日志-获取用户列表")
@Operation(summary = "系统设置-组织-日志-获取用户列表")
@RequiresPermissions(PermissionConstants.ORGANIZATION_LOG_READ)
public List<User> getLogUserList(@PathVariable(value = "organizationId") String organizationId) {
return userService.getUserListByOrgId(organizationId);
@ -68,7 +68,7 @@ public class OrganizationLogController {
@PostMapping("/list")
@Operation(summary = "组织-日志-组织菜单下操作日志列表查询")
@Operation(summary = "系统设置-组织-日志-组织菜单下操作日志列表查询")
@RequiresPermissions(PermissionConstants.ORGANIZATION_LOG_READ)
public Pager<List<OperationLogResponse>> organizationLogList(@Validated @RequestBody OperationLogRequest request) {
Page<Object> page = PageHelper.startPage(request.getCurrent(), request.getPageSize(),

14
backend/services/system-setting/src/main/java/io/metersphere/system/controller/PluginController.java
View File

@ -31,21 +31,21 @@ import java.util.List;
*/
@RestController
@RequestMapping("/plugin")
@Tag(name = "系统设置-插件")
@Tag(name = "系统设置-系统-插件管理")
public class PluginController {
@Resource
private PluginService pluginService;
@GetMapping("/list")
@Operation(summary = "系统设置-插件-获取插件列表")
@Operation(summary = "系统设置-系统-插件管理-获取插件列表")
@RequiresPermissions(PermissionConstants.SYSTEM_PLUGIN_READ)
public List<PluginDTO> list() {
return pluginService.list();
}
@PostMapping("/add")
@Operation(summary = "系统设置-插件-创建插件")
@Operation(summary = "系统设置-系统-插件管理-创建插件")
@RequiresPermissions(PermissionConstants.SYSTEM_PLUGIN_ADD)
@Log(type = OperationLogType.UPDATE, expression = "#msClass.addLog(#request)", msClass = PluginLogService.class)
public Plugin add(@Validated({Created.class}) @RequestPart(value = "request") PluginUpdateRequest request,
@ -55,7 +55,7 @@ public class PluginController {
}
@PostMapping("/update")
@Operation(summary = "系统设置-插件-更新插件")
@Operation(summary = "系统设置-系统-插件管理-更新插件")
@RequiresPermissions(PermissionConstants.SYSTEM_PLUGIN_UPDATE)
@Log(type = OperationLogType.ADD, expression = "#msClass.updateLog(#request)", msClass = PluginLogService.class)
public Plugin update(@Validated({Updated.class}) @RequestBody PluginUpdateRequest request) {
@ -65,7 +65,7 @@ public class PluginController {
}
@GetMapping("/delete/{id}")
@Operation(summary = "系统设置-插件-删除插件")
@Operation(summary = "系统设置-系统-插件管理-删除插件")
@RequiresPermissions(PermissionConstants.SYSTEM_PLUGIN_DELETE)
@Log(type = OperationLogType.DELETE, expression = "#msClass.deleteLog(#id)", msClass = PluginLogService.class)
public void delete(@PathVariable String id) {
@ -73,14 +73,14 @@ public class PluginController {
}
@GetMapping("/script/get/{pluginId}/{scriptId}")
@Operation(summary = "系统设置-插件-获取插件对应表单的脚本内容")
@Operation(summary = "系统设置-系统-插件管理-获取插件对应表单的脚本内容")
@RequiresPermissions(PermissionConstants.SYSTEM_PLUGIN_READ)
public String getScript(@PathVariable String pluginId, @PathVariable String scriptId) {
return pluginService.getScript(pluginId, scriptId);
}
@GetMapping("/image/{pluginId}")
@Operation(summary = "系统设置-插件-获取插件的图片资源")
@Operation(summary = "系统设置-系统-插件管理-获取插件的图片资源")
public void getPluginImg(
@Schema(description = "插件ID", requiredMode = Schema.RequiredMode.REQUIRED)
@PathVariable("pluginId")

16
backend/services/system-setting/src/main/java/io/metersphere/system/controller/ServiceIntegrationController.java
View File

@ -28,21 +28,21 @@ import java.util.List;
*/
@RestController
@RequestMapping("/service/integration")
@Tag(name = "组织-服务集成")
@Tag(name = "系统设置-组织-服务集成")
public class ServiceIntegrationController {
@Resource
private ServiceIntegrationService serviceIntegrationService;
@GetMapping("/list/{organizationId}")
@Operation(summary = "组织-服务集成-获取服务集成列表")
@Operation(summary = "系统设置-组织-服务集成-获取服务集成列表")
@RequiresPermissions(PermissionConstants.SYSTEM_SERVICE_INTEGRATION_READ)
public List<ServiceIntegrationDTO> list(@PathVariable String organizationId) {
return serviceIntegrationService.list(organizationId);
}
@PostMapping("/add")
@Operation(summary = "组织-服务集成-创建服务集成")
@Operation(summary = "系统设置-组织-服务集成-创建服务集成")
@RequiresPermissions(PermissionConstants.SYSTEM_SERVICE_INTEGRATION_ADD)
@Log(type = OperationLogType.UPDATE, expression = "#msClass.addLog(#request)", msClass = ServiceIntegrationLogService.class)
public ServiceIntegration add(@Validated({Created.class}) @RequestBody ServiceIntegrationUpdateRequest request) {
@ -50,7 +50,7 @@ public class ServiceIntegrationController {
}
@PostMapping("/update")
@Operation(summary = "组织-服务集成-更新服务集成")
@Operation(summary = "系统设置-组织-服务集成-更新服务集成")
@RequiresPermissions(PermissionConstants.SYSTEM_SERVICE_INTEGRATION_UPDATE)
@Log(type = OperationLogType.ADD, expression = "#msClass.updateLog(#request)", msClass = ServiceIntegrationLogService.class)
public ServiceIntegration update(@Validated({Updated.class}) @RequestBody ServiceIntegrationUpdateRequest request) {
@ -58,7 +58,7 @@ public class ServiceIntegrationController {
}
@GetMapping("/delete/{id}")
@Operation(summary = "组织-服务集成-删除服务集成")
@Operation(summary = "系统设置-组织-服务集成-删除服务集成")
@RequiresPermissions(PermissionConstants.SYSTEM_SERVICE_INTEGRATION_DELETE)
@Log(type = OperationLogType.DELETE, expression = "#msClass.deleteLog(#id)", msClass = ServiceIntegrationLogService.class)
public void delete(@PathVariable String id) {
@ -66,7 +66,7 @@ public class ServiceIntegrationController {
}
@PostMapping("/validate/{pluginId}")
@Operation(summary = "组织-服务集成-校验服务集成信息")
@Operation(summary = "系统设置-组织-服务集成-校验服务集成信息")
@RequiresPermissions(PermissionConstants.SYSTEM_SERVICE_INTEGRATION_UPDATE)
public void validate(@PathVariable String pluginId,
@Validated({Updated.class})
@ -78,14 +78,14 @@ public class ServiceIntegrationController {
}
@GetMapping("/validate/{id}")
@Operation(summary = "组织-服务集成-校验服务集成信息")
@Operation(summary = "系统设置-组织-服务集成-校验服务集成信息")
@RequiresPermissions(PermissionConstants.SYSTEM_SERVICE_INTEGRATION_UPDATE)
public void validate(@PathVariable String id) {
serviceIntegrationService.validate(id);
}
@GetMapping("/script/{pluginId}")
@Operation(summary = "组织-服务集成-获取前端配置脚本")
@Operation(summary = "系统设置-组织-服务集成-获取前端配置脚本")
@RequiresPermissions(PermissionConstants.SYSTEM_SERVICE_INTEGRATION_READ)
public Object getPluginScript(@PathVariable String pluginId) {
return serviceIntegrationService.getPluginScript(pluginId);

14
backend/services/system-setting/src/main/java/io/metersphere/system/controller/SystemParameterController.java
View File

@ -19,7 +19,7 @@ import java.util.HashMap;
import java.util.List;
@RestController
@Tag(name = "系统参数")
@Tag(name = "系统设置-系统-系统参数-基础设置")
@RequestMapping("/system/parameter")
public class SystemParameterController {
@ -28,7 +28,7 @@ public class SystemParameterController {
@PostMapping("/save/base-info")
@Operation(summary = "系统参数-基础设置-基本信息-保存")
@Operation(summary = "系统设置-系统-系统参数-基础设置-基本信息-保存")
@RequiresPermissions(PermissionConstants.SYSTEM_PARAMETER_SETTING_BASE_READ_UPDATE)
@Log(type = OperationLogType.UPDATE, expression = "#msClass.updateBaseLog(#systemParameter)", msClass = SystemParameterService.class)
public void saveBaseParameter(@Validated @RequestBody List<SystemParameter> systemParameter) {
@ -37,7 +37,7 @@ public class SystemParameterController {
@GetMapping("/get/base-info")
@Operation(summary = "系统参数-基本设置-基本信息-获取")
@Operation(summary = "系统设置-系统-系统参数-基本设置-基本信息-获取")
@RequiresPermissions(PermissionConstants.SYSTEM_PARAMETER_SETTING_BASE_READ)
public BaseSystemConfigDTO getBaseInfo() {
return systemParameterService.getBaseInfo();
@ -45,7 +45,7 @@ public class SystemParameterController {
@GetMapping("/get/email-info")
@Operation(summary = "系统参数-基本设置-邮件设置-获取邮件信息")
@Operation(summary = "系统设置-系统-系统参数-基本设置-邮件设置-获取邮件信息")
@RequiresPermissions(PermissionConstants.SYSTEM_PARAMETER_SETTING_BASE_READ)
public EMailInfoDto getEmailInfo() {
return systemParameterService.getEmailInfo();
@ -53,7 +53,7 @@ public class SystemParameterController {
@PostMapping("/edit/email-info")
@Operation(summary = "系统参数-基本设置-邮件设置-保存邮件信息")
@Operation(summary = "系统设置-系统-系统参数-基本设置-邮件设置-保存邮件信息")
@RequiresPermissions(PermissionConstants.SYSTEM_PARAMETER_SETTING_BASE_READ_UPDATE)
@Log(type = OperationLogType.UPDATE, expression = "#msClass.updateLog(#systemParameter)", msClass = SystemParameterService.class)
public void editEMailInfo(@Validated @RequestBody List<SystemParameter> systemParameter) {
@ -62,7 +62,7 @@ public class SystemParameterController {
@PostMapping("/test/email")
@Operation(summary = "系统参数-基本设置-邮件设置-测试连接")
@Operation(summary = "系统设置-系统-系统参数-基本设置-邮件设置-测试连接")
@RequiresPermissions(PermissionConstants.SYSTEM_PARAMETER_SETTING_BASE_READ)
public void testEmailConnection(@RequestBody HashMap<String, String> hashMap) {
systemParameterService.testEmailConnection(hashMap);
@ -70,7 +70,7 @@ public class SystemParameterController {
@GetMapping("/save/base-url")
@Operation(summary = "系统参数-默认站点替换接口")
@Operation(summary = "系统设置-系统-系统参数-默认站点替换接口")
public void saveBaseurl(@RequestParam("baseUrl") String baseUrl) {
systemParameterService.saveBaseUrl(baseUrl);
}