api模块

src/main/java/com/tykj/workflowcore/api/controller/ApiController.java

@@ -3,6 +3,8 @@ package com.tykj.workflowcore.api.controller;
 import com.tykj.workflowcore.api.entity.ClassInfo;
 import com.tykj.workflowcore.api.entity.InvokeRequest;
 import com.tykj.workflowcore.api.service.ApiService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -11,7 +13,7 @@ import org.springframework.web.bind.annotation.RestController;
 
 import java.util.List;
 
-
+@Api(tags = "函数管理接口")
 @RestController("/api/info")
 public class ApiController {
 
@@ -21,11 +23,13 @@ public class ApiController {
         this.apiService = apiService;
     }
 
+    @ApiOperation(value =  "查询所有可调用函数信息")
     @GetMapping
     public ResponseEntity<List<ClassInfo>> findAll() {
         return ResponseEntity.ok(apiService.findAll());
     }
 
+    @ApiOperation(value = "调用指定函数")
     @PostMapping
     public void invoke(@RequestBody InvokeRequest invokeRequest) {
         apiService.invoke(invokeRequest.getClassName(),invokeRequest.getName(),invokeRequest.getParams());

src/main/java/com/tykj/workflowcore/api/entity/ApiInfo.java

 package com.tykj.workflowcore.api.entity;
 
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -11,11 +12,13 @@ import java.util.List;
 @AllArgsConstructor
 @NoArgsConstructor
 public class ApiInfo {
-
+    @ApiModelProperty(value = "所属类名")
     private String className;
 
+    @ApiModelProperty(value = "参数信息")
     private List<EntityInfo> params;
 
+    @ApiModelProperty(value = "返回信息")
     private EntityInfo ret;
 
 }

src/main/java/com/tykj/workflowcore/api/entity/ClassInfo.java

 package com.tykj.workflowcore.api.entity;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -11,8 +12,10 @@ import java.util.List;
 @NoArgsConstructor
 public class ClassInfo {
 
+    @ApiModelProperty(value = "类名")
     private String className;
 
+    @ApiModelProperty(value = "函数信息")
     private List<ApiInfo> apiInfos;
 
 }

src/main/java/com/tykj/workflowcore/api/entity/EntityInfo.java

 package com.tykj.workflowcore.api.entity;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -11,10 +12,13 @@ import java.util.List;
 @NoArgsConstructor
 public class EntityInfo {
 
+    @ApiModelProperty(value = "类名")
     private String className;
 
+    @ApiModelProperty(value = "参数名")
     private String name;
 
+    @ApiModelProperty(value = "变量信息")
     private List<EntityInfo> fields;
 
 }

src/main/java/com/tykj/workflowcore/api/entity/InvokeRequest.java

 package com.tykj.workflowcore.api.entity;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -11,10 +12,13 @@ import java.util.List;
 @NoArgsConstructor
 public class InvokeRequest {
 
+    @ApiModelProperty(value = "类名")
     private String className;
 
+    @ApiModelProperty(value = "函数名")
     private String name;
 
+    @ApiModelProperty(value = "参数信息")
     private List<Parameter> params;
 
 }

src/main/java/com/tykj/workflowcore/api/entity/Parameter.java

 package com.tykj.workflowcore.api.entity;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -14,12 +15,14 @@ public class Parameter {
     /**
      * 类名
      */
+    @ApiModelProperty(value = "类名")
     private String className;
 
     /**
      * Map形式的实例对象
      * key为字段名 value为字段值
      */
+    @ApiModelProperty(value = "实例对象")
     private Map<String,Object> instance;
 
 }