程序包 io.github.code.visual.web

类 WorkflowController

java.lang.Object

io.github.code.visual.web.WorkflowController

@RestController
@ConditionalOnProperty(name="visual.flow.enable-api",
                       havingValue="true",
                       matchIfMissing=true)
public class WorkflowController
extends Object

Built-in REST controller for workflow management and execution.

从以下版本开始:

09/18/2023

作者:

Levi Li

构造器概要

构造器

构造器	说明
WorkflowController(WorkflowEngine engine, WorkflowRepository repository, VisualFlowProperties properties)

方法概要

修饰符和类型	方法	说明
List<Diagnostic>	compileScript(ScriptRequest request)
Map<String,Object>	config()
WorkflowMetadata	createWorkflow(WorkflowMetadata metadata)
Map<Integer,List<WorkflowTaskLog>>	debugWorkflow(DebugRequest debugRequest)
org.springframework.web.servlet.mvc.method.annotation.SseEmitter	debugWorkflowStream(DebugRequest debugRequest)
void	deleteWorkflow(Integer id)
Map<Integer,List<WorkflowTaskLog>>	executeWorkflow(Map<String,Object> request)
WorkflowMetadata	getWorkflow(Integer id)
List<WorkflowIdAndName>	listWorkflows()
WorkflowMetadata	updateWorkflow(Integer id, WorkflowMetadata metadata)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

WorkflowController

public WorkflowController(WorkflowEngine engine,
 WorkflowRepository repository,
 VisualFlowProperties properties)

方法详细资料

config

@GetMapping("${visual.flow.basePath:/visualflow}/api/config")
public Map<String,Object> config()

listWorkflows

@GetMapping("${visual.flow.basePath:/visualflow}/api/workflows")
public List<WorkflowIdAndName> listWorkflows()

createWorkflow

@PostMapping("${visual.flow.basePath:/visualflow}/api/workflows")
public WorkflowMetadata createWorkflow(@RequestBody
 WorkflowMetadata metadata)

getWorkflow

@GetMapping("${visual.flow.basePath:/visualflow}/api/workflows/{id}")
public WorkflowMetadata getWorkflow(@PathVariable("id")
 Integer id)

updateWorkflow

@PutMapping("${visual.flow.basePath:/visualflow}/api/workflows/{id}")
public WorkflowMetadata updateWorkflow(@PathVariable("id")
 Integer id,
 @RequestBody
 WorkflowMetadata metadata)

deleteWorkflow

@DeleteMapping("${visual.flow.basePath:/visualflow}/api/workflows/{id}")
public void deleteWorkflow(@PathVariable("id")
 Integer id)

executeWorkflow

@PostMapping("${visual.flow.basePath:/visualflow}/api/workflows/execute")
public Map<Integer,List<WorkflowTaskLog>> executeWorkflow(@RequestBody
 Map<String,Object> request)

debugWorkflow

@PostMapping("${visual.flow.basePath:/visualflow}/api/workflows/debug")
public Map<Integer,List<WorkflowTaskLog>> debugWorkflow(@RequestBody
 DebugRequest debugRequest)

debugWorkflowStream

@PostMapping(value="${visual.flow.basePath:/visualflow}/api/workflows/debug/stream",
             produces="text/event-stream")
public org.springframework.web.servlet.mvc.method.annotation.SseEmitter debugWorkflowStream(@RequestBody
 DebugRequest debugRequest)

compileScript

@PostMapping("${visual.flow.basePath:/visualflow}/api/script/compile")
public List<Diagnostic> compileScript(@RequestBody
 ScriptRequest request)