📄 DOC_VALIDATION_GUIDE.md

⬇️ 下载文件

wolai-sync Skill 文档验证指南

⚠️ 重要提示

当前 Skill 是基于通用的 REST API 设计模式开发的,尚未参考 wolai 官方 API 文档

为了确保完全符合 wolai 实际 API,请按以下步骤验证和更新:


第一步:获取官方文档

方法1:网页版获取

  1. 登录 wolai 网页版
  2. 查找「API」、「开发者」或「设置」中的 API 相关入口
  3. 复制以下内容的官方文档:
    • API 基础 URL(如:https://api.wolai.com/v1 是否正确)
    • 认证方式(Bearer token 是否正确)
    • 页面操作的端点和请求格式
    • 内容块(blocks)的数据结构

方法2:联系 wolai 支持

如果找不到文档,建议:

  • 联系 wolai 客服获取 API 文档
  • 查看 wolai 官方网站的开发者页面
  • 搜索 "wolai API documentation"

第二步:测试当前实现

运行测试脚本验证基本功能:

cd /root/.openclaw/workspace/skills/wolai-sync
./test_wolai.sh YOUR_API_TOKEN

观察输出

  • ✅ API 连接成功 → 说明认证机制正确
  • ❌ 401/403 错误 → 检查 token 或认证方式
  • ❌ 404 错误 → 检查 API URL 或端点路径
  • ❌ 400 错误 → 检查请求格式和参数

第三步:对比文档修正

如果发现当前实现与官方文档不符:

常见问题修正

问题1:API URL 错误

编辑 scripts/wolai_api.py

self.base_url = "https://正确的api地址.com/v1"  # 修改为官方地址

问题2:认证方式错误

编辑 scripts/wolai_api.py

self.headers = {
    "Authorization": f"Bearer {api_token}",  # 或 "Token {api_token}" 等
    "Content-Type": "application/json"
}

问题3:端点路径错误

编辑相应方法:

# 创建页面
url = f"{self.base_url}/正确的端点路径"

# 更新页面
url = f"{self.base_url}/正确的端点路径/{page_id}"

问题4:请求格式错误

编辑请求数据:

data = {
    # 根据官方文档调整字段名和结构
    "parent_id": parent_id,
    "title": title,
    "type": "page"  # 或 "database" 等
}

问题5:内容块格式错误

编辑块创建函数:

def create_text_block(text):
    return {
        "type": "text",  # 或 "paragraph" 等官方类型
        "content": text  # 或 "text", "data" 等官方字段
    }

第四步:重新打包 Skill

修改完成后重新打包:

python3 /root/.openclaw/workspace/skills/skill-creator/scripts/package_skill.py /root/.openclaw/workspace/skills/wolai-sync

建议的协作方式

选项A:你提供文档,我来修正

  1. 你访问 wolai API 文档页面
  2. 复制关键内容(API 端点、请求格式、示例)
  3. 将内容粘贴给我
  4. 我根据文档完全重新实现

选项B:我指导你修正

  1. 你运行测试脚本
  2. 把错误信息和官方文档位置告诉我
  3. 我指导你修改具体代码
  4. 重新测试

选项C:先测试,再迭代

  1. 先用当前版本测试基本功能
  2. 遇到具体问题再调整
  3. 逐步完善实现

当前实现 vs 典型 API 设计

当前假设

基于 Notion API 等类似产品设计:

# 假设的 API 结构
base_url = "https://api.wolai.com/v1"
headers = {
    "Authorization": f"Bearer {token}",
    "Content-Type": "application/json"
}

# 页面操作
POST   /databases          # 创建页面
PATCH  /databases/{id}     # 更新页面
GET    /databases/{id}     # 获取页面
POST   /search             # 搜索页面

需要验证的点

  • API 基础 URL 是否正确
  • 认证头格式是否正确(Bearer Token 还是其他)
  • 页面端点路径是否正确(/databases 还是 /pages)
  • 请求方法是否正确(POST/PUT/PATCH)
  • 请求体格式是否符合要求
  • 内容块结构是否正确
  • 错误处理是否符合规范

如何联系我

当你:

  • ✅ 找到了官方文档
  • ✅ 运行测试遇到错误
  • ✅ 发现 API 与实现不符

请直接把:

  1. 文档链接或文档内容截图
  2. 错误信息
  3. API 响应示例

发给我,我会立即帮你修正!


快速验证清单

运行以下命令并告诉我结果:

cd /root/.openclaw/workspace/skills/wolai-sync

# 1. 测试 API 连接
./test_wolai.sh YOUR_TOKEN

# 2. 创建测试对话文件
cat > test_conv.json << 'EOF'
{
  "messages": [
    {"role": "user", "content": "测试"},
    {"role": "assistant", "content": "测试回复"}
  ]
}
EOF

# 3. 测试同步(需要你的 page_id)
python3 scripts/sync_auto_notify.py \
  --token YOUR_TOKEN \
  --page-id YOUR_PAGE_ID \
  --conversation-file test_conv.json \
  --user-id 33558EFB7CF362DA4A894FBE2E93DFDE

把输出结果发给我,我会分析具体问题!