用途:完成首次 Figma REST API 调用,获取文件元数据与文档树,并查看构成设计各图层与对象的节点结构。适合开始新的 Figma 集成、测试 API 连通性或学习节点树时使用。
前提条件:已完成 figma-install-auth 设置;拥有 Figma 文件 key(来自 URL:figma.com/design/<FILE_KEY>/...);已设置 FIGMA_PAT 环境变量。
主要能力与用法:
- 获取文件:使用 curl 携带 X-Figma-Token 请求 https://api.figma.com/v1/files/${FIGMA_FILE_KEY},可配合 jq 提取名称、最后修改时间、版本与页面名。
- 理解节点树:文件是带类型的节点树,根为 DOCUMENT,下含 CANVAS(页面)、FRAME、GROUP、TEXT、RECTANGLE、VECTOR、COMPONENT、COMPONENT_SET、INSTANCE、SECTION、BOOLEAN_OPERATION 等类型。
- TypeScript 示例:通过 fetch 请求同一端点,检查响应状态,输出文件名、最后修改时间、组件与样式数量,并遍历第一页列出顶层 frame 的类型、名称与 ID。
- 获取指定节点:请求 /v1/files/${fileKey}/nodes?ids=${ids},ids 为逗号分隔的节点 ID,格式如 "0:1"、"123:456",返回 data.nodes 映射。
输出:文件元数据(名称、版本、最后修改时间)、页面名称、带节点 ID 与类型的顶层 frame、组件与样式数量。
错误处理:404 表示文件 key 无效,需核对 URL;403 表示无文件访问权限,需检查 token 作用域与文件权限;429 表示请求过多,需遵循 Retry-After 头;200 但文档为空表示文件没有页面,需确认文件是否刚创建。
限制:资料未提供收费、价格、平台支持范围或性能指标等信息。后续可参考 figma-local-dev-loop 设置开发工作流。