API 参考 / requirement-graph

读取需求四层关系图谱

GET /api/v1/requirement-graph · getRequirementGraph

返回当前项目调用者可见范围内的里程碑、需求室、需求和 WorkItem 节点，以及层级边和需求引用边。 节点按稳定顺序截断到 300 个；被裁剪节点的边也一并裁剪，truncated=true 表示结果不是完整图谱。 可选 roomId 把构图收窄到一个需求室子图（该室、室内需求、归属这些需求或直接挂在该室的工作项、 覆盖这些需求的里程碑，以及两端都还在图上的引用边），避免项目级 300 上限挡住最新卡的边。

鉴权：项目 API Token（Authorization: Bearer wfp_…）。详见 Agent 接入。

参数

roomId
string —— 按需求室收窄四层图谱。缺省返回整个项目可见图谱。

响应字段 · 200

nodes（必填）
RequirementGraphNode[]
nodes[].id（必填）
string
nodes[].type（必填）
enum；取值：milestone / requirement_room / requirement / work_item
nodes[].displayKey（必填）
string
nodes[].title（必填）
string
nodes[].status（必填）
string
nodes[].href（必填）
string
edges（必填）
RequirementGraphEdge[]
edges[].source（必填）
string
edges[].target（必填）
string
edges[].type（必填）
enum；取值：milestone_requirement / milestone_room / room_requirement / requirement_work_item / work_item_parent / requirement_reference
truncated（必填）
boolean

错误

请求示例（curl）

curl -X GET "https://你的项目.workflow.games/api/v1/requirement-graph?roomId=…" \
  -H "Authorization: Bearer wfp_…"

响应示例

HTTP/1.1 200
{
  "nodes": [
    {
      "id": "018f3c2e-0000-7000-8000-000000000000",
      "type": "milestone",
      "displayKey": "示例文本",
      "title": "示例标题",
      "status": "示例文本",
      "href": "示例文本"
    }
  ],
  "edges": [
    {
      "source": "示例文本",
      "target": "示例文本",
      "type": "milestone_requirement"
    }
  ],
  "truncated": true
}

合同真值：OpenAPI 3.1（0.1.0）。

相关：Agent 接入指南 · 使用指南 · API 参考索引

Workflow 正在加载…