Workflow API
由
scripts/generate-api-docs.ts自动生成 —— 请勿手改 共 13 个端点
GET /workflow
获取用户的所有工作流
响应
| 状态码 | 说明 |
|---|---|
| 200 |
DELETE /workflow/{workflowId}
删除工作流
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
workflowId | path | string | ✅ |
响应
| 状态码 | 说明 |
|---|---|
| 200 |
GET /workflow/{workflowId}
获取工作流详情
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
workflowId | path | string | ✅ |
响应
| 状态码 | 说明 |
|---|---|
| 200 |
PUT /workflow/{workflowId}
更新工作流
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
workflowId | path | string | ✅ |
请求体
json
{
"$ref": "#/components/schemas/UpdateWorkflowDto"
}响应
| 状态码 | 说明 |
|---|---|
| 200 |
POST /workflow/{workflowId}/connections
添加工作流连接
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
workflowId | path | string | ✅ |
请求体
json
{
"$ref": "#/components/schemas/AddWorkflowConnectionDto"
}响应
| 状态码 | 说明 |
|---|---|
| 201 |
POST /workflow/{workflowId}/execute
执行工作流
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
workflowId | path | string | ✅ |
请求体
json
{
"$ref": "#/components/schemas/ExecuteWorkflowDto"
}响应
| 状态码 | 说明 |
|---|---|
| 201 |
GET /workflow/{workflowId}/executions
获取工作流执行历史
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
workflowId | path | string | ✅ | |
limit | query | number | ✅ | |
offset | query | number | ✅ |
响应
| 状态码 | 说明 |
|---|---|
| 200 |
POST /workflow/{workflowId}/nodes
添加工作流节点
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
workflowId | path | string | ✅ |
请求体
json
{
"$ref": "#/components/schemas/AddWorkflowNodeDto"
}响应
| 状态码 | 说明 |
|---|---|
| 201 |
POST /workflow/{workflowId}/pause
暂停工作流
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
workflowId | path | string | ✅ |
响应
| 状态码 | 说明 |
|---|---|
| 201 |
POST /workflow/{workflowId}/publish
发布工作流
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
workflowId | path | string | ✅ |
请求体
json
{
"$ref": "#/components/schemas/PublishWorkflowDto"
}响应
| 状态码 | 说明 |
|---|---|
| 201 |
POST /workflow/create
创建新的工作流
请求体
json
{
"$ref": "#/components/schemas/CreateWorkflowDto"
}响应
| 状态码 | 说明 |
|---|---|
| 201 |
GET /workflow/executions/{executionId}
获取工作流执行详情
请求参数
| 参数名 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
executionId | path | string | ✅ |
响应
| 状态码 | 说明 |
|---|---|
| 200 |
POST /workflow/validate
验证工作流结构
请求体
json
{
"$ref": "#/components/schemas/ValidateWorkflowDto"
}响应
| 状态码 | 说明 |
|---|---|
| 201 |