refactor: 拆分接口文档分组配置及 controller 到各自模块

2025-09-09 08:57:16 +08:00 · 2025-06-14 22:12:05 +08:00
parent f1a87b4c23
commit 93bd70dc5c
32 changed files with 257 additions and 80 deletions
--- a/continew-plugin/continew-plugin-generator/pom.xml
+++ b/continew-plugin/continew-plugin-generator/pom.xml
@@ -14,4 +14,12 @@

    <name>${project.artifactId}</name>
    <description>代码生成器插件</description>
+
+    <dependencies>
+        <!-- 系统管理模块 -->
+        <dependency>
+            <groupId>top.continew</groupId>
+            <artifactId>continew-system</artifactId>
+        </dependency>
+    </dependencies>
 </project>
--- a/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/config/CodeConfiguration.java
+++ b/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/config/CodeConfiguration.java
@@ -0,0 +1,27 @@
+package top.continew.admin.generator.config;
+
+import org.springdoc.core.models.GroupedOpenApi;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * 代码生成配置
+ *
+ * @author Charles7c
+ * @since 2025/6/14 21:22
+ */
+@Configuration
+public class CodeConfiguration {
+
+    /**
+     * API 文档分组配置
+     */
+    @Bean
+    public GroupedOpenApi codeApi() {
+        return GroupedOpenApi.builder()
+                             .group("code")
+                             .displayName("代码生成")
+                             .pathsToMatch("/code/**")
+                             .build();
+    }
+}
--- a/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/controller/GeneratorController.java
+++ b/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/controller/GeneratorController.java
@@ -0,0 +1,123 @@
+/*
+ * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package top.continew.admin.generator.controller;
+
+import cn.dev33.satoken.annotation.SaCheckPermission;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import jakarta.servlet.http.HttpServletResponse;
+import lombok.RequiredArgsConstructor;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.*;
+import top.continew.admin.generator.model.entity.FieldConfigDO;
+import top.continew.admin.generator.model.entity.GenConfigDO;
+import top.continew.admin.generator.model.query.GenConfigQuery;
+import top.continew.admin.generator.model.req.GenConfigReq;
+import top.continew.admin.generator.model.resp.GeneratePreviewResp;
+import top.continew.admin.generator.service.GeneratorService;
+import top.continew.admin.system.service.DictService;
+import top.continew.starter.extension.crud.model.query.PageQuery;
+import top.continew.starter.extension.crud.model.resp.LabelValueResp;
+import top.continew.starter.extension.crud.model.resp.PageResp;
+
+import java.sql.SQLException;
+import java.util.List;
+
+/**
+ * 代码生成 API
+ *
+ * @author Charles7c
+ * @since 2023/8/3 22:58
+ */
+@Tag(name = "代码生成 API")
+@Validated
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/code/generator")
+public class GeneratorController {
+
+    private final GeneratorService baseService;
+    private final DictService dictService;
+
+    @Operation(summary = "分页查询生成配置", description = "分页查询生成配置列表")
+    @SaCheckPermission("code:generator:list")
+    @GetMapping("/config")
+    public PageResp<GenConfigDO> pageGenConfig(GenConfigQuery query, @Validated PageQuery pageQuery) {
+        return baseService.pageGenConfig(query, pageQuery);
+    }
+
+    @Operation(summary = "查询生成配置信息", description = "查询生成配置信息")
+    @Parameter(name = "tableName", description = "表名称", required = true, example = "sys_user", in = ParameterIn.PATH)
+    @SaCheckPermission("code:generator:list")
+    @GetMapping("/config/{tableName}")
+    public GenConfigDO getGenConfig(@PathVariable String tableName) throws SQLException {
+        return baseService.getGenConfig(tableName);
+    }
+
+    @Operation(summary = "查询字段配置列表", description = "查询字段配置列表")
+    @Parameter(name = "tableName", description = "表名称", required = true, example = "sys_user", in = ParameterIn.PATH)
+    @Parameter(name = "requireSync", description = "是否需要同步", example = "false", in = ParameterIn.QUERY)
+    @SaCheckPermission("code:generator:config")
+    @GetMapping("/field/{tableName}")
+    public List<FieldConfigDO> listFieldConfig(@PathVariable String tableName,
+                                               @RequestParam(required = false, defaultValue = "false") Boolean requireSync) {
+        return baseService.listFieldConfig(tableName, requireSync);
+    }
+
+    @Operation(summary = "保存配置信息", description = "保存配置信息")
+    @Parameter(name = "tableName", description = "表名称", required = true, example = "sys_user", in = ParameterIn.PATH)
+    @SaCheckPermission("code:generator:config")
+    @PostMapping("/config/{tableName}")
+    public void saveConfig(@Validated @RequestBody GenConfigReq req, @PathVariable String tableName) {
+        baseService.saveConfig(req, tableName);
+    }
+
+    @Operation(summary = "生成预览", description = "预览生成代码")
+    @Parameter(name = "tableNames", description = "表名称", required = true, example = "sys_user", in = ParameterIn.PATH)
+    @SaCheckPermission("code:generator:preview")
+    @GetMapping("/preview/{tableNames}")
+    public List<GeneratePreviewResp> preview(@PathVariable List<String> tableNames) {
+        return baseService.preview(tableNames);
+    }
+
+    @Operation(summary = "生成下载代码", description = "生成下载代码")
+    @Parameter(name = "tableNames", description = "表名称", required = true, example = "sys_user", in = ParameterIn.PATH)
+    @SaCheckPermission("code:generator:generate")
+    @PostMapping("/{tableNames}/download")
+    public void downloadCode(@PathVariable List<String> tableNames, HttpServletResponse response) {
+        baseService.downloadCode(tableNames, response);
+    }
+
+    @Operation(summary = "生成代码", description = "生成代码")
+    @Parameter(name = "tableNames", description = "表名称", required = true, example = "sys_user", in = ParameterIn.PATH)
+    @SaCheckPermission("code:generator:generate")
+    @PostMapping("/{tableNames}")
+    public void generateCode(@PathVariable List<String> tableNames) {
+        baseService.generateCode(tableNames);
+    }
+
+    @Operation(summary = "查询字典", description = "查询字典列表")
+    @SaCheckPermission("code:generator:config")
+    @GetMapping("/dict")
+    public List<LabelValueResp> listDict() {
+        List<LabelValueResp> dictList = dictService.listDict(null, null);
+        dictList.addAll(dictService.listEnumDict());
+        return dictList;
+    }
+}
--- a/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/config/OpenConfiguration.java
+++ b/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/config/OpenConfiguration.java
@@ -0,0 +1,27 @@
+package top.continew.admin.open.config;
+
+import org.springdoc.core.models.GroupedOpenApi;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * 能力开放配置
+ *
+ * @author Charles7c
+ * @since 2025/6/14 21:22
+ */
+@Configuration
+public class OpenConfiguration {
+
+    /**
+     * API 文档分组配置
+     */
+    @Bean
+    public GroupedOpenApi openApi() {
+        return GroupedOpenApi.builder()
+                             .group("open")
+                             .displayName("能力开放")
+                             .pathsToMatch("/open/**")
+                             .build();
+    }
+}
--- a/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/controller/AppController.java
+++ b/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/controller/AppController.java
@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package top.continew.admin.open.controller;
+
+import cn.dev33.satoken.annotation.SaCheckPermission;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PatchMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RestController;
+import top.continew.admin.common.controller.BaseController;
+import top.continew.admin.open.model.query.AppQuery;
+import top.continew.admin.open.model.req.AppReq;
+import top.continew.admin.open.model.resp.AppDetailResp;
+import top.continew.admin.open.model.resp.AppResp;
+import top.continew.admin.open.model.resp.AppSecretResp;
+import top.continew.admin.open.service.AppService;
+import top.continew.starter.extension.crud.annotation.CrudRequestMapping;
+import top.continew.starter.extension.crud.enums.Api;
+
+/**
+ * 应用管理 API
+ *
+ * @author chengzi
+ * @author Charles7c
+ * @since 2024/10/17 16:03
+ */
+@Tag(name = "应用管理 API")
+@RestController
+@RequiredArgsConstructor
+@CrudRequestMapping(value = "/open/app", api = {Api.PAGE, Api.GET, Api.CREATE, Api.UPDATE, Api.DELETE, Api.EXPORT})
+public class AppController extends BaseController<AppService, AppResp, AppDetailResp, AppQuery, AppReq> {
+
+    @Operation(summary = "获取密钥", description = "获取应用密钥")
+    @Parameter(name = "id", description = "ID", example = "1", in = ParameterIn.PATH)
+    @SaCheckPermission("open:app:secret")
+    @GetMapping("/{id}/secret")
+    public AppSecretResp getSecret(@PathVariable Long id) {
+        return baseService.getSecret(id);
+    }
+
+    @Operation(summary = "重置密钥", description = "重置应用密钥")
+    @Parameter(name = "id", description = "ID", example = "1", in = ParameterIn.PATH)
+    @SaCheckPermission("open:app:resetSecret")
+    @PatchMapping("/{id}/secret")
+    public void resetSecret(@PathVariable Long id) {
+        baseService.resetSecret(id);
+    }
+}
--- a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/config/ScheduleConfiguration.java
+++ b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/config/ScheduleConfiguration.java
@@ -0,0 +1,27 @@
+package top.continew.admin.schedule.config;
+
+import org.springdoc.core.models.GroupedOpenApi;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * 任务调度配置
+ *
+ * @author Charles7c
+ * @since 2025/6/14 21:22
+ */
+@Configuration
+public class ScheduleConfiguration {
+
+    /**
+     * API 文档分组配置
+     */
+    @Bean
+    public GroupedOpenApi scheduleApi() {
+        return GroupedOpenApi.builder()
+                             .group("schedule")
+                             .displayName("任务调度")
+                             .pathsToMatch("/schedule/**")
+                             .build();
+    }
+}
--- a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/controller/JobController.java
+++ b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/controller/JobController.java
@@ -0,0 +1,109 @@
+/*
+ * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package top.continew.admin.schedule.controller;
+
+import cn.dev33.satoken.annotation.SaCheckPermission;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.*;
+import top.continew.admin.schedule.model.query.JobQuery;
+import top.continew.admin.schedule.model.req.JobReq;
+import top.continew.admin.schedule.model.req.JobStatusReq;
+import top.continew.admin.schedule.model.req.JobTriggerReq;
+import top.continew.admin.schedule.model.resp.JobResp;
+import top.continew.admin.schedule.service.JobService;
+import top.continew.starter.extension.crud.model.resp.PageResp;
+import top.continew.starter.extension.crud.validation.CrudValidationGroup;
+import top.continew.starter.log.annotation.Log;
+
+import java.util.List;
+
+/**
+ * 任务 API
+ *
+ * @author KAI
+ * @author Charles7c
+ * @since 2024/6/25 22:24
+ */
+@Tag(name = " 任务 API")
+@Validated
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/schedule/job")
+public class JobController {
+
+    private final JobService baseService;
+
+    @Operation(summary = "分页查询任务列表", description = "分页查询任务列表")
+    @SaCheckPermission("schedule:job:list")
+    @GetMapping
+    public PageResp<JobResp> page(JobQuery query) {
+        return baseService.page(query);
+    }
+
+    @Operation(summary = "新增任务", description = "新增任务")
+    @SaCheckPermission("schedule:job:create")
+    @PostMapping
+    public void create(@Validated(CrudValidationGroup.Create.class) @RequestBody JobReq req) {
+        baseService.create(req);
+    }
+
+    @Operation(summary = "修改任务", description = "修改任务")
+    @Parameter(name = "id", description = "ID", example = "1", in = ParameterIn.PATH)
+    @SaCheckPermission("schedule:job:update")
+    @PutMapping("/{id}")
+    public void update(@Validated(CrudValidationGroup.Update.class) @RequestBody JobReq req, @PathVariable Long id) {
+        baseService.update(req, id);
+    }
+
+    @Operation(summary = "修改任务状态", description = "修改任务状态")
+    @SaCheckPermission("schedule:job:update")
+    @PatchMapping("/{id}/status")
+    public void updateStatus(@Validated @RequestBody JobStatusReq req, @PathVariable Long id) {
+        baseService.updateStatus(req, id);
+    }
+
+    @Operation(summary = "删除任务", description = "删除任务")
+    @Parameter(name = "id", description = "ID", example = "1", in = ParameterIn.PATH)
+    @SaCheckPermission("schedule:job:delete")
+    @DeleteMapping("/{id}")
+    public void delete(@PathVariable Long id) {
+        baseService.delete(id);
+    }
+
+    @Operation(summary = "执行任务", description = "执行任务")
+    @Parameter(name = "id", description = "ID", example = "1", in = ParameterIn.PATH)
+    @SaCheckPermission("schedule:job:trigger")
+    @PostMapping("/trigger/{id}")
+    public void trigger(@PathVariable Long id) {
+        JobTriggerReq req = new JobTriggerReq();
+        req.setJobId(id);
+        baseService.trigger(req);
+    }
+
+    @Log(ignore = true)
+    @Operation(summary = "查询任务分组列表", description = "查询任务分组列表")
+    @SaCheckPermission("schedule:job:list")
+    @GetMapping("/group")
+    public List<String> listGroup() {
+        return baseService.listGroup();
+    }
+}
--- a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/controller/JobLogController.java
+++ b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/controller/JobLogController.java
@@ -0,0 +1,90 @@
+/*
+ * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package top.continew.admin.schedule.controller;
+
+import cn.dev33.satoken.annotation.SaCheckPermission;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.*;
+import top.continew.admin.schedule.model.JobInstanceLogPageResult;
+import top.continew.admin.schedule.model.query.JobInstanceLogQuery;
+import top.continew.admin.schedule.model.query.JobInstanceQuery;
+import top.continew.admin.schedule.model.query.JobLogQuery;
+import top.continew.admin.schedule.model.resp.JobInstanceResp;
+import top.continew.admin.schedule.model.resp.JobLogResp;
+import top.continew.admin.schedule.service.JobLogService;
+import top.continew.starter.extension.crud.model.resp.PageResp;
+
+import java.util.List;
+
+/**
+ * 任务日志 API
+ *
+ * @author KAI
+ * @author Charles7c
+ * @since 2024/6/27 22:24
+ */
+@Tag(name = " 任务日志 API")
+@Validated
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/schedule/log")
+public class JobLogController {
+
+    private final JobLogService baseService;
+
+    @Operation(summary = "分页查询任务日志列表", description = "分页查询任务日志列表")
+    @SaCheckPermission("schedule:log:list")
+    @GetMapping
+    public PageResp<JobLogResp> page(JobLogQuery query) {
+        return baseService.page(query);
+    }
+
+    @Operation(summary = "停止任务", description = "停止任务")
+    @Parameter(name = "id", description = "ID", example = "1", in = ParameterIn.PATH)
+    @SaCheckPermission("schedule:log:stop")
+    @PostMapping("/stop/{id}")
+    public void stop(@PathVariable Long id) {
+        baseService.stop(id);
+    }
+
+    @Operation(summary = "重试任务", description = "重试任务")
+    @Parameter(name = "id", description = "ID", example = "1", in = ParameterIn.PATH)
+    @SaCheckPermission("schedule:log:retry")
+    @PostMapping("/retry/{id}")
+    public void retry(@PathVariable Long id) {
+        baseService.retry(id);
+    }
+
+    @Operation(summary = "查询任务实例列表", description = "查询任务实例列表")
+    @SaCheckPermission("schedule:log:list")
+    @GetMapping("/instance")
+    public List<JobInstanceResp> listInstance(JobInstanceQuery query) {
+        return baseService.listInstance(query);
+    }
+
+    @Operation(summary = "分页查询任务实例日志列表", description = "分页查询任务实例日志列表")
+    @SaCheckPermission("schedule:log:list")
+    @GetMapping("/instance/log")
+    public JobInstanceLogPageResult pageInstanceLog(JobInstanceLogQuery query) {
+        return baseService.pageInstanceLog(query);
+    }
+}