Flow ServerStarter
入口入口节点

REST 入口

type rest

在设计器中打开 ↗

暴露 REST 接口,并生成 <routeId>-impl 处理链

使用说明

要点:暴露 REST 接口并生成 <routeId>-impl 处理链。只支持 GET / POST / PUT / DELETE。JSON 请求体默认以原始流进入流程;要在 Groovy / Simple 中按字段访问,先加一个 unmarshal(format=json,type=java.util.Map)节点。

属性

字段类型必填默认值说明
method
HTTP 方法
枚举 必填 GET
可选值:GET、POST、PUT、DELETE
path
路径
文本 可选 — /demo/hello/{name}
service
服务名
文本 可选 —
desc
流程描述
文本 可选 —
params
参数定义
对象数组 可选 — 每项 {name, type, desc}
auth
执行鉴权
枚举 可选 public 默认 public(公开)
可选值:public、token
authHeader
鉴权 Header
文本 可选 — 默认 Authorization,auth=token 时生效
secretRef
密钥引用
文本 可选 — flow.secrets 中的键,auth=token 时必填

示例流程

可直接保存为 demo-rest.json 并部署;非入口节点默认套了一个 REST 入口。

Flow JSON
{
  "id": "demo-rest",
  "desc": "REST 入口 示例",
  "group": "示例/入口",
  "schemaVersion": 1,
  "nodes": [
    {
      "type": "rest",
      "props": {
        "method": "POST",
        "path": "/demo/echo",
        "desc": "回显请求体",
        "params": [
          {
            "name": "name",
            "type": "string",
            "desc": "名称"
          }
        ]
      },
      "id": "n1"
    },
    {
      "type": "setBody",
      "props": {
        "lang": "simple",
        "script": "你好,${body[name]}"
      },
      "id": "n2"
    }
  ]
}
部署这段流程
curl -X POST 'http://localhost:8086/flow' \
  -H 'Content-Type: application/json' \
  -H 'X-Flow-Token: change-me' \
  --data-binary @demo-rest.json

调用方式

调用示例
curl -X POST 'http://localhost:8086/demo/echo' \
  -H 'Content-Type: application/json' \
  -d '{"name":"bobo"}'

相关节点