cloud：完善 system、infra、bpm 的 api swagger 注解

yudao-module-bpm/yudao-module-bpm-api/pom.xml

@@ -22,12 +22,26 @@
             <artifactId>yudao-common</artifactId>
         </dependency>
 
+        <!-- Web 相关 -->
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-ui</artifactId>
+            <scope>provided</scope>
+        </dependency>
+
         <!-- 参数校验 -->
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-validation</artifactId>
             <optional>true</optional>
         </dependency>
+
+        <!-- RPC 远程调用相关 -->
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-openfeign</artifactId>
+            <optional>true</optional>
+        </dependency>
     </dependencies>
 
 </project>

yudao-module-bpm/yudao-module-bpm-api/src/main/java/cn/iocoder/yudao/module/bpm/api/task/BpmProcessInstanceApi.java

@@ -1,23 +1,27 @@
 package cn.iocoder.yudao.module.bpm.api.task;
 
 import cn.iocoder.yudao.module.bpm.api.task.dto.BpmProcessInstanceCreateReqDTO;
+import cn.iocoder.yudao.module.bpm.enums.ApiConstants;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestParam;
 
 import javax.validation.Valid;
 
-/**
- * 流程实例 Api 接口
- *
- * @author 芋道源码
- */
+@FeignClient(name = ApiConstants.NAME) // TODO 芋艿：fallbackFactory =
+@Tag(name = "RPC 服务 - 流程实例")
 public interface BpmProcessInstanceApi {
 
-    /**
-     * 创建流程实例（提供给内部）
-     *
-     * @param userId 用户编号
-     * @param reqDTO 创建信息
-     * @return 实例的编号
-     */
-    String createProcessInstance(Long userId, @Valid BpmProcessInstanceCreateReqDTO reqDTO);
+    String PREFIX = ApiConstants.PREFIX + "/process-instance";
+
+    @PostMapping(PREFIX + "/create")
+    @Operation(summary = "创建流程实例（提供给内部），返回实例编号")
+    @Parameter(name = "userId", description = "用户编号", required = true, example = "1")
+    String createProcessInstance(@RequestParam("userId") Long userId,
+                                 @Valid @RequestBody BpmProcessInstanceCreateReqDTO reqDTO);
 
 }

yudao-module-bpm/yudao-module-bpm-api/src/main/java/cn/iocoder/yudao/module/bpm/api/task/dto/BpmProcessInstanceCreateReqDTO.java

@@ -1,33 +1,24 @@
 package cn.iocoder.yudao.module.bpm.api.task.dto;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 import javax.validation.constraints.NotEmpty;
 import java.util.Map;
 
-/**
- * 流程实例的创建 Request DTO
- *
- * @author 芋道源码
- */
+@Schema(description = "RPC 服务 - 流程实例的创建 Request DTO")
 @Data
 public class BpmProcessInstanceCreateReqDTO {
 
-    /**
-     * 流程定义的标识
-     */
+    @Schema(description = "流程定义的标识", requiredMode = Schema.RequiredMode.REQUIRED, example = "leave")
     @NotEmpty(message = "流程定义的标识不能为空")
     private String processDefinitionKey;
-    /**
-     * 变量实例
-     */
+
+    @Schema(description = "变量实例", requiredMode = Schema.RequiredMode.REQUIRED)
     private Map<String, Object> variables;
 
-    /**
-     * 业务的唯一标识
-     *
-     * 例如说，请假申请的编号。通过它，可以查询到对应的实例
-     */
-    @NotEmpty(message = "业务的唯一标识")
-    private String businessKey;
+    @Schema(description = "业务的唯一标识", requiredMode = Schema.RequiredMode.REQUIRED)
+    @NotEmpty(message = "业务的唯一标识不能为空")
+    private String businessKey; // 例如说，请假申请的编号。通过它，可以查询到对应的实例
+
 }

yudao-module-bpm/yudao-module-bpm-api/src/main/java/cn/iocoder/yudao/module/bpm/enums/ApiConstants.java

@@ -0,0 +1,23 @@
+package cn.iocoder.yudao.module.bpm.enums;
+
+import cn.iocoder.yudao.framework.common.enums.RpcConstants;
+
+/**
+ * API 相关的枚举
+ *
+ * @author 芋道源码
+ */
+public class ApiConstants {
+
+    /**
+     * 服务名
+     *
+     * 注意，需要保证和 spring.application.name 保持一致
+     */
+    public static final String NAME = "bpm-server";
+
+    public static final String PREFIX = RpcConstants.RPC_API_PREFIX + "/bpm";
+
+    public static final String VERSION = "1.0.0";
+
+}