TAPD OpenAPI
环境变量（已预置）
TAPD_API_ENDPOINT - API 地址, 如果 TAPD_API_ENDPOINT 已配置，则优先使用 TAPD_API_ENDPOINT 的替换文档中的 ${TAPD_API_ENDPOINT}TAPD_WORKSPACE_IDS - 项目 ID 列表，逗号分隔，优先级高于 TAPD_WORKSPACE_IDTAPD_WORKSPACE_ID - 单个项目 ID（兼容旧配置）TAPD_TOKEN - 认证 Token（Bearer 方式）
Workspace 处理规则
调用前必须先确定实际使用的 workspace 列表：
# 优先取 TAPD_WORKSPACE_IDS，回退到 TAPD_WORKSPACE_ID
if [ -n "$TAPD_WORKSPACE_IDS" ]; then
WS_LIST=$(echo "$TAPD_WORKSPACE_IDS" | tr ',' ' ')
else
WS_LIST="$TAPD_WORKSPACE_ID"
fi
- 若
WS_LIST 只有一个 ID，按单 workspace 正常请求即可
- 若有多个 ID，需对每个 ID 分别调用 API，再汇总结果（求和、合并列表等，根据用户意图决定）
- 注意 curl 的时候 workspace_id 用逗号分隔后的，例如 $TAPD_WORKSPACE_IDS 是 "31372104,68119668"，则 curl 的时候需要分别调用
workspace_id=31372104 和 workspace_id=68119668
请求模板
# GET
curl -s -H "Authorization: Bearer $TAPD_TOKEN" \
"${TAPD_API_ENDPOINT}/${path}?workspace_id=${ws_id}"
# POST
curl -s -X POST -H "Authorization: Bearer $TAPD_TOKEN" \
-H "Content-Type: application/json" \
"${TAPD_API_ENDPOINT}/${path}" \
-d '{"workspace_id":"'"${ws_id}"'","key":"value"}'
查询 API 文档
API 文档位于 ~/.codebuddy/skills/tapd-openapi/references/ 目录。
1. 列出所有服务：
ls ~/.codebuddy/skills/tapd-openapi/references/
2. 列出服务下的 API：
ls ~/.codebuddy/skills/tapd-openapi/references/stories/
3. 查看 API 详情：
cat ~/.codebuddy/skills/tapd-openapi/references/stories/liststories.md
常用服务
| 服务 |
说明 |
常用 API 文件 |
| stories |
需求管理 |
liststories, countstories, addstory, updatestory, getrelatedbugs, getstoryfieldsinfo |
| bugs |
缺陷管理 |
listbugs, countbugs, addbug, updatebug, getbugfieldsinfo |
| iterations |
迭代管理 |
listiterations |
| tasks |
任务管理 |
listtasks, counttasks, addtask, updatetask |
| comments |
评论管理 |
listcomments, countcomments, addcomment |
| wikis |
Wiki 管理 |
listwikis, countwikis, addwiki, updatewiki, searchwiki（见下方） |
| timesheets |
工时花费 |
listtimesheets, counttimesheets, addtimesheet, updatetimesheet |
| attachments |
附件管理 |
listattachments, downloadattachment, getimage, downloaddocument |
| users |
用户信息 |
getuserinfo, listworkspaces |
调用流程
- 确定服务：根据需求从常用服务中选择，或用
ls 查看全部
- 查找 API：用
ls ~/.codebuddy/skills/tapd-openapi/references/{服务}/ 找到具体操作
- 获取详情：用
cat 读取 API 文档，获取请求方法、路径、参数
- 执行请求：按模板构造 curl 命令，
workspace_id 必传
Wiki 搜索
TAPD API 不支持 Wiki 全文搜索，通过本地脚本实现。详见：
cat ~/.codebuddy/skills/tapd-openapi/references/wikis/searchwiki.md
1---2name: tapd-openapi3description: TAPD OpenAPI skill，用于需求、缺陷、任务、迭代、Wiki、评论、工时、附件等 TAPD 平台操作。当用户提到「TAPD」「需求」「story」「缺陷」「bug」「任务」「task」「迭代」「iteration」「sprint」「工时」「timesheet」「Wiki」「评论」「comment」「附件」或需要在 TAPD 中查询、创建、更新、统计相关内容时，使用此 skill。支持需求管理、缺陷管理、任务管理、迭代管理、Wiki 管理（含全文搜索）、评论管理、工时花费管理、附件管理及用户信息查询等功能。4---5
6# TAPD OpenAPI
7
8## 环境变量（已预置）
9
10- `TAPD_API_ENDPOINT` - API 地址, 如果 `TAPD_API_ENDPOINT` 已配置，则优先使用 `TAPD_API_ENDPOINT` 的替换文档中的 `${TAPD_API_ENDPOINT}`
11- `TAPD_WORKSPACE_IDS` - 项目 ID 列表，逗号分隔，**优先级高于** `TAPD_WORKSPACE_ID`
12- `TAPD_WORKSPACE_ID` - 单个项目 ID（兼容旧配置）
13- `TAPD_TOKEN` - 认证 Token（Bearer 方式）
14
15## Workspace 处理规则
16
17**调用前必须先确定实际使用的 workspace 列表：**
18
19```bash
20# 优先取 TAPD_WORKSPACE_IDS，回退到 TAPD_WORKSPACE_ID
21if [ -n "$TAPD_WORKSPACE_IDS" ]; then
22 WS_LIST=$(echo "$TAPD_WORKSPACE_IDS" | tr ',' ' ')
23else
24 WS_LIST="$TAPD_WORKSPACE_ID"
25fi
26```
27
28- 若 `WS_LIST` 只有一个 ID，按单 workspace 正常请求即可
29- 若有多个 ID，需对每个 ID 分别调用 API，再汇总结果（求和、合并列表等，根据用户意图决定）
30- 注意 curl 的时候 workspace_id 用逗号分隔后的，例如 $TAPD_WORKSPACE_IDS 是 "31372104,68119668"，则 curl 的时候需要分别调用 `workspace_id=31372104` 和 `workspace_id=68119668`
31
32## 请求模板
33
34```bash
35# GET
36curl -s -H "Authorization: Bearer $TAPD_TOKEN" \
37 "${TAPD_API_ENDPOINT}/${path}?workspace_id=${ws_id}"
38
39# POST
40curl -s -X POST -H "Authorization: Bearer $TAPD_TOKEN" \
41 -H "Content-Type: application/json" \
42 "${TAPD_API_ENDPOINT}/${path}" \
43 -d '{"workspace_id":"'"${ws_id}"'","key":"value"}'
44```
45
46## 查询 API 文档
47
48API 文档位于 `~/.codebuddy/skills/tapd-openapi/references/` 目录。
49
50**1. 列出所有服务**：
51```bash
52ls ~/.codebuddy/skills/tapd-openapi/references/
53```
54
55**2. 列出服务下的 API**：
56```bash
57ls ~/.codebuddy/skills/tapd-openapi/references/stories/
58```
59
60**3. 查看 API 详情**：
61```bash
62cat ~/.codebuddy/skills/tapd-openapi/references/stories/liststories.md
63```
64
65## 常用服务
66
67| 服务 | 说明 | 常用 API 文件 |
68|------|------|---------------|
69| stories | 需求管理 | liststories, countstories, addstory, updatestory, getrelatedbugs, getstoryfieldsinfo |
70| bugs | 缺陷管理 | listbugs, countbugs, addbug, updatebug, getbugfieldsinfo |
71| iterations | 迭代管理 | listiterations |
72| tasks | 任务管理 | listtasks, counttasks, addtask, updatetask |
73| comments | 评论管理 | listcomments, countcomments, addcomment |
74| wikis | Wiki 管理 | listwikis, countwikis, addwiki, updatewiki, **searchwiki**（见下方） |
75| timesheets | 工时花费 | listtimesheets, counttimesheets, addtimesheet, updatetimesheet |
76| attachments | 附件管理 | listattachments, downloadattachment, getimage, downloaddocument |
77| users | 用户信息 | getuserinfo, listworkspaces |
78
79## 调用流程
80
811. **确定服务**：根据需求从常用服务中选择，或用 `ls` 查看全部
822. **查找 API**：用 `ls ~/.codebuddy/skills/tapd-openapi/references/{服务}/` 找到具体操作
833. **获取详情**：用 `cat` 读取 API 文档，获取请求方法、路径、参数
844. **执行请求**：按模板构造 curl 命令，`workspace_id` 必传
85
86## Wiki 搜索
87
88TAPD API 不支持 Wiki 全文搜索，通过本地脚本实现。详见：
89
90```bash
91cat ~/.codebuddy/skills/tapd-openapi/references/wikis/searchwiki.md
92```
bighardperson