update - 根据 Restful 规范调整 Controller 的 HTTP 协议请求方式

2023-07-21 17:21:49 +08:00 · 2023-07-21 17:21:49 +08:00 · dd3b32c0af
commit dd3b32c0af
parent 52ba6778e1
4 changed files with 37 additions and 27 deletions
--- a/workflow-engine-server/src/main/java/cn/axzo/workflow/server/controller/web/BpmCategoryController.java
+++ b/workflow-engine-server/src/main/java/cn/axzo/workflow/server/controller/web/BpmCategoryController.java
@ -9,7 +9,6 @@ import cn.azxo.framework.common.model.CommonResponse;
 import com.alibaba.fastjson.JSON;
 import com.baomidou.mybatisplus.core.metadata.IPage;
 import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
-import io.swagger.annotations.ApiParam;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.extern.slf4j.Slf4j;
@ -29,7 +28,7 @@ public class BpmCategoryController {


    @Operation(summary = "创建分类")
-    @PutMapping("/create")
+    @PostMapping("/create")
    public CommonResponse<String> create(@Valid @RequestBody BpmCategoryCreateDTO dto) {
        log.info("创建Category===>>>参数：{}", JSON.toJSONString(dto));
        bpmCategoryService.createBpmCategory(dto);
@ -38,7 +37,7 @@ public class BpmCategoryController {


    @Operation(summary = "更新分类")
-    @PostMapping("/update")
+    @PutMapping("/update")
    public CommonResponse<String> update(@Valid @RequestBody BpmCategoryUpdateDTO dto) {
        log.info("更新Category===>>>参数：{}", JSON.toJSONString(dto));
        bpmCategoryService.updateBpmCategory(dto);
@ -48,9 +47,9 @@ public class BpmCategoryController {

    @Operation(summary = "分类列表")
    @GetMapping("/list")
-    public CommonResponse<IPage<BpmCategoryItemVo>> list(BpmCategoryDTO qo) {
-        log.info("查询Category===>>>列表接口参数，{}", JSON.toJSONString(qo));
-        Page<BpmCategoryItemVo> bpmCategory = bpmCategoryService.findBpmCategory(qo);
+    public CommonResponse<IPage<BpmCategoryItemVo>> list(@RequestBody BpmCategoryDTO dto) {
+        log.info("查询Category===>>>列表接口参数，{}", JSON.toJSONString(dto));
+        Page<BpmCategoryItemVo> bpmCategory = bpmCategoryService.findBpmCategory(dto);
        return CommonResponse.success(bpmCategory);
    }

@ -63,8 +62,8 @@ public class BpmCategoryController {


    @Operation(summary = "删除分类")
-    @DeleteMapping("/delete/{id}")
-    public CommonResponse<String> delete(@ApiParam(" ID") @PathVariable Long id) {
+    @DeleteMapping("/delete")
+    public CommonResponse<String> delete(@RequestParam Long id) {
        log.info("删除Category===>>>参数，{}", id);
        bpmCategoryService.deleteBpmCategory(id);
        return CommonResponse.success();
--- a/workflow-engine-server/src/main/java/cn/axzo/workflow/server/controller/web/BpmModelController.java
+++ b/workflow-engine-server/src/main/java/cn/axzo/workflow/server/controller/web/BpmModelController.java
@ -9,6 +9,8 @@ import cn.axzo.workflow.core.service.dto.response.model.BpmModelDetailVO;
 import cn.axzo.workflow.core.service.dto.response.model.BpmModelPageItemVO;
 import cn.azxo.framework.common.model.CommonResponse;
 import com.alibaba.fastjson.JSON;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.validation.annotation.Validated;
@ -17,6 +19,7 @@ import org.springframework.web.bind.annotation.*;
 import javax.validation.Valid;
 import javax.validation.constraints.NotBlank;

+@Tag(name = "运维管理 - 流程模型")
@Slf4j
@RequestMapping("/web/v1/api/model")
@RestController
@ -29,6 +32,7 @@ public class BpmModelController {
    /**
     * 获取流程模型的查询结果
     */
+    @Operation(summary = "流程模型列表")
    @GetMapping("/getModelPage")
    public CommonResponse<BpmPageResult<BpmModelPageItemVO>> modelPage(@Valid @RequestBody BpmModelBpmPageDTO dto) {
        log.info("获取流程模型getModelPage===>>>参数：{}", JSON.toJSONString(dto));
@ -41,7 +45,8 @@ public class BpmModelController {
     * 创建流程,
     * return modelId的主键
     */
-    @PutMapping("/create")
+    @Operation(summary = "创建流程模型")
+    @PostMapping("/create")
    public CommonResponse<String> create(@Valid @RequestBody BpmModelCreateDTO dto) {
        log.info("创建流程createBpmModel===>>>参数：{}", JSON.toJSONString(dto));
        String result = bpmModelService.createBpmModel(dto);
@ -51,8 +56,9 @@ public class BpmModelController {
    /**
     * 获取模型
     */
+    @Operation(summary = "通过模型ID查询指定流程模型")
    @GetMapping("/get")
-    public CommonResponse<BpmModelDetailVO> getModelDetailById(@RequestBody String modelId) {
+    public CommonResponse<BpmModelDetailVO> getModelDetailById(@RequestParam String modelId) {
        log.info("获取模型getModelDetailById===>>>参数：{}", JSON.toJSONString(modelId));
        BpmModelDetailVO result = bpmModelService.getModelDetailById(modelId);
        return CommonResponse.success(result);
@ -62,8 +68,9 @@ public class BpmModelController {
    /**
     * 获取模型
     */
+    @Operation(summary = "通过模型KEY查询指定流程模型")
    @GetMapping("/getByKey")
-    public CommonResponse<BpmModelDetailVO> getModelDetailByKey(@RequestBody String modelKey) {
+    public CommonResponse<BpmModelDetailVO> getModelDetailByKey(@RequestParam String modelKey) {
        log.info("获取模型getModelDetailByKey===>>>参数：{}", JSON.toJSONString(modelKey));
        BpmModelDetailVO result = bpmModelService.getModelDetailByKey(modelKey);
        return CommonResponse.success(result);
@ -73,6 +80,7 @@ public class BpmModelController {
    /**
     * 修改流程信息
     */
+    @Operation(summary = "更新流程模型")
    @PutMapping("/update")
    public CommonResponse<String> updateBpmModel(@Valid @RequestBody BpmModelUpdateDTO dto) {
        log.info("修改流程信息updateBpmModel===>>>参数：{}", JSON.toJSONString(dto));
@ -85,8 +93,9 @@ public class BpmModelController {
     * 部署模型
     * return 部署完成的流程定义Id
     */
+    @Operation(summary = "通过模型ID部署流程")
    @PostMapping("/deploy")
-    public CommonResponse<String> deployBpmModelById(@Valid @NotBlank(message = "模型 ID 不能为空") String modelId) {
+    public CommonResponse<String> deployBpmModelById(@Valid @NotBlank(message = "模型 ID 不能为空") @RequestParam String modelId) {
        log.info("部署模型deployBpmModelById===>>>参数：{}", JSON.toJSONString(modelId));
        String result = bpmModelService.deployBpmModelById(modelId);
        return CommonResponse.success(result);
@ -97,8 +106,9 @@ public class BpmModelController {
     * 部署模型
     * return 部署完成的流程定义Id
     */
+    @Operation(summary = "通过模型KEY部署流程")
    @PostMapping("/deployByKey")
-    public CommonResponse<String> deployBpmModelByKey(@Valid @NotBlank(message = "模型 Key 不能为空") String modelKey) {
+    public CommonResponse<String> deployBpmModelByKey(@Valid @NotBlank(message = "模型 Key 不能为空") @RequestParam String modelKey) {
        log.info("部署模型deployBpmModelByKey===>>>参数：{}", JSON.toJSONString(modelKey));
        String result = bpmModelService.deployBpmModelByKey(modelKey);
        return CommonResponse.success(result);
@ -108,8 +118,9 @@ public class BpmModelController {
    /**
     * 删除模型
     */
-    @PostMapping("/delete")
-    public CommonResponse deleteBpmModel(@RequestBody String id) {
+    @Operation(summary = "删除指定模型ID的模型")
+    @DeleteMapping("/delete")
+    public CommonResponse deleteBpmModel(@RequestParam String id) {
        log.info("删除模型deleteBpmModel===>>>参数：{}", JSON.toJSONString(id));
        bpmModelService.deleteBpmModel(id);
        return CommonResponse.success();
--- a/workflow-engine-server/src/main/java/cn/axzo/workflow/server/controller/web/BpmProcessDefinitionController.java
+++ b/workflow-engine-server/src/main/java/cn/axzo/workflow/server/controller/web/BpmProcessDefinitionController.java
@ -10,10 +10,7 @@ import lombok.extern.slf4j.Slf4j;
 import org.flowable.common.engine.impl.db.SuspensionState;
 import org.flowable.engine.repository.ProcessDefinition;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.RequestBody;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.*;

 import javax.validation.Valid;

@ -43,7 +40,7 @@ public class BpmProcessDefinitionController {
     * @return 流程定义
     */
    @GetMapping("/get")
-    public CommonResponse<ProcessDefinition> getProcessDefinition(@RequestBody String id) {
+    public CommonResponse<ProcessDefinition> getProcessDefinition(@RequestParam String id) {
        log.info("获取活跃的流程定义分页getProcessDefinition===>>>参数：{}", JSON.toJSONString(id));
        ProcessDefinition result = bpmProcessDefinitionService.getProcessDefinition(id);
        return CommonResponse.success(result);
@ -57,7 +54,7 @@ public class BpmProcessDefinitionController {
     * @return 流程定义
     */
    @GetMapping("/getByDeploymentId")
-    public CommonResponse<ProcessDefinition> getProcessDefinitionByDeploymentId(@RequestBody String deploymentId) {
+    public CommonResponse<ProcessDefinition> getProcessDefinitionByDeploymentId(@RequestParam String deploymentId) {
        log.info(" 获得 deploymentId 对应的 getProcessDefinitionByDeploymentId===>>>参数：{}", JSON.toJSONString(deploymentId));
        ProcessDefinition result = bpmProcessDefinitionService.getProcessDefinitionByDeploymentId(deploymentId);
        return CommonResponse.success(result);
@ -71,7 +68,7 @@ public class BpmProcessDefinitionController {
     * @return 流程定义
     */
    @GetMapping("/active/getByKey")
-    public CommonResponse<ProcessDefinition> getActiveProcessDefinitionByKey(@RequestBody String key) {
+    public CommonResponse<ProcessDefinition> getActiveProcessDefinitionByKey(@RequestParam String key) {
        log.info("获得流程定义标识对应的激活的流程定义 getActiveProcessDefinitionByKey===>>>参数：{}", JSON.toJSONString(key));
        ProcessDefinition result = bpmProcessDefinitionService.getActiveProcessDefinitionByKey(key);
        return CommonResponse.success(result);
@ -84,8 +81,9 @@ public class BpmProcessDefinitionController {
     * 挂起：SuspensionState.SUSPENDED.getStateCode()
     * {@link SuspensionState}
     */
-    @GetMapping("/state/update")
-    public CommonResponse getActiveProcessDefinitionByKey(@RequestBody String processDefinitionId, Integer state) {
+    @PutMapping("/state/update")
+    public CommonResponse getActiveProcessDefinitionByKey(@RequestParam String processDefinitionId,
+                                                          @RequestParam Integer state) {
        log.info("挂起/激活流程 updateProcessDefinitionSuspendedState===>>>参数：{},{}", processDefinitionId, state);
        bpmProcessDefinitionService.updateProcessDefinitionSuspendedState(processDefinitionId, state);
        return CommonResponse.success();
@ -98,7 +96,8 @@ public class BpmProcessDefinitionController {
     * @return 流程定义ID
     */
    @GetMapping("/active/getById")
-    public CommonResponse<String> getActiveProcessDefinitionId(@RequestBody String tenantId, String category) {
+    public CommonResponse<String> getActiveProcessDefinitionId(@RequestParam String tenantId,
+                                                               @RequestParam String category) {
        log.info("挂起/激活流程 getActiveProcessDefinitionId===>>>参数：{},{}", tenantId, category);
        String result = bpmProcessDefinitionService.getActiveProcessDefinitionId(tenantId, category);
        return CommonResponse.success(result);
--- a/workflow-engine-server/src/main/java/cn/axzo/workflow/server/controller/web/BpmProcessInstanceController.java
+++ b/workflow-engine-server/src/main/java/cn/axzo/workflow/server/controller/web/BpmProcessInstanceController.java
@ -84,8 +84,9 @@ public class BpmProcessInstanceController {
     * @param processInstanceId 流程实例的编号
     * @param status            租户Id
     */
-    @GetMapping("/status/update")
-    public CommonResponse<Boolean> updateProcessStatus(@RequestBody String processInstanceId, String status) {
+    @PutMapping("/status/update")
+    public CommonResponse<Boolean> updateProcessStatus(@RequestParam String processInstanceId,
+                                                       @RequestParam String status) {
        log.info("获得流程实例 updateProcessStatus===>>>参数：{},{}", processInstanceId, status);
        Boolean result = bpmProcessInstanceService.updateProcessStatus(processInstanceId, status);
        return CommonResponse.success(result);