超腾开源平台工具模块

工具模块提供网站检测、SEO 优化、IndexNow 推送、XWiki 同步、百度推送、网站链接管理等功能。

目录

• 网站检测工具
• SEO 优化工具
• IndexNow 工具
• XWiki 同步工具
• 百度推送工具
• 网站链接管理

网站检测工具

网站检测工具提供网站健康检查、链接检测、SEO 分析等功能。

网站检测任务管理

创建网站检测任务

接口地址: POST /api/tool/website-check/create

需要认证: 是

请求体:

{
  "name": "网站健康检测",
  "url": "https://example.com",
  "check_type": "full",
  "options": {
    "check_links": true,
    "check_images": true,
    "check_seo": true,
    "max_depth": 3,
    "timeout": 30
  }
}

请求字段说明:

获取任务进度

接口地址: GET /api/tool/website-check/progress/{task_id}

需要认证: 是

路径参数:

响应示例:

{
  "success": true,
  "code": 200,
  "msg": "操作成功",
  "data": {
    "task_id": "1",
    "status": "running",
    "progress": 45,
    "total_urls": 100,
    "checked_urls": 45,
    "failed_urls": 3,
    "start_time": "2026-01-01T00:00:00Z",
    "estimated_time": 300
  }
}

获取任务检测结果

接口地址: GET /api/tool/website-check/results/{task_id}

需要认证: 是

响应示例:

{
  "success": true,
  "code": 200,
  "msg": "操作成功",
  "data": {
    "task_id": "1",
    "summary": {
      "total_urls": 100,
      "success_count": 95,
      "failed_count": 3,
      "warning_count": 2
    },
    "results": [
      {
        "url": "https://example.com/page1",
        "status": "success",
        "response_time": 200,
        "issues": []
      },
      {
        "url": "https://example.com/page2",
        "status": "failed",
        "error": "404 Not Found",
        "issues": ["链接无法访问"]
      }
    ]
  }
}

SEO 优化工具

SEO 优化工具提供网站 SEO 分析、优化建议等功能。

SEO 优化任务管理

创建 SEO 优化任务

接口地址: POST /api/tool/seo-optimization/create

需要认证: 是

请求体:

{
  "name": "首页SEO优化",
  "url": "https://example.com",
  "optimization_type": "on_page",
  "target_keywords": ["开源", "平台", "开发"]
}

响应示例:

{
  "success": true,
  "code": 200,
  "msg": "创建成功",
  "data": {
    "id": "1",
    "name": "首页SEO优化",
    "url": "https://example.com",
    "status": "pending",
    "score": 0,
    "suggestions": [],
    "create_time": "2026-01-01T00:00:00Z"
  }
}

IndexNow 工具

IndexNow 工具提供向各大搜索引擎提交 URL 的功能。

提交 URL 到搜索引擎

接口地址: POST /api/tool/index-now/submit

需要认证: 是

请求体:

{
  "urls": ["https://example.com/page1", "https://example.com/page2"],
  "host": "example.com",
  "key": "your-indexnow-key"
}

请求字段说明:

响应示例:

{
  "success": true,
  "code": 200,
  "msg": "提交成功",
  "data": {
    "submitted_count": 2,
    "search_engines": ["Bing", "Google", "Yandex", "Baidu"]
  }
}

XWiki 同步工具

XWiki 同步工具提供 XWiki 内容同步功能。

同步控制

开始同步

接口地址: POST /api/tool/xwiki-sync/start

需要认证: 是

请求体:

{
  "sync_type": "full",
  "space_names": ["Main", "Documentation"],
  "include_deleted": false
}

响应示例:

{
  "success": true,
  "code": 200,
  "msg": "同步已启动",
  "data": {
    "sync_id": "sync_123456",
    "status": "running"
  }
}

XWiki 同步日志

百度推送工具

百度推送工具提供 URL 推送到百度的功能。

推送 URL 到百度

接口地址: POST /api/tool/baidu-push/push

需要认证: 是

请求体:

{
  "urls": ["https://example.com/page1", "https://example.com/page2"],
  "site": "https://example.com",
  "token": "your-baidu-token"
}

响应示例:

{
  "success": true,
  "code": 200,
  "msg": "推送成功",
  "data": {
    "success_count": 2,
    "remain_count": 98,
    "not_same_site": 0,
    "not_valid": 0
  }
}

网站链接管理

网站链接管理模块提供内部链接和外部链接的管理功能。

网站链接 CRUD

创建网站链接

接口地址: POST /api/tool/website-links/create

需要认证: 是

请求体:

{
  "source_url": "https://example.com/page1",
  "target_url": "https://example.com/page2",
  "link_type": "internal",
  "anchor_text": "链接文本",
  "rel": "nofollow",
  "status": "active"
}

请求字段说明:

枚举类型说明

检测任务状态 (CheckTaskStatus)

链接状态 (LinkStatus)

使用示例

Python 示例

import requests

base_url = 'http://localhost:8000/api/tool'
token = 'your_access_token'
headers = {'Authorization': f'Bearer {token}'}

# 创建网站检测任务
response = requests.post(
    f'{base_url}/website-check/create',
    headers=headers,
    json={
        'name': '网站健康检测',
        'url': 'https://example.com',
        'check_type': 'full'
    }
)
task_data = response.json()
task_id = task_data['data']['id']

# 获取任务进度
response = requests.get(
    f'{base_url}/website-check/progress/{task_id}',
    headers=headers
)
print(response.json())

# 提交URL到搜索引擎
response = requests.post(
    f'{base_url}/index-now/submit',
    headers=headers,
    json={
        'urls': ['https://example.com/page1'],
        'host': 'example.com',
        'key': 'your-key'
    }
)
print(response.json())

JavaScript 示例

// 创建SEO优化任务
async function createSEOTask(token, taskData) {
  const response = await fetch(
    "http://localhost:8000/api/tool/seo-optimization/create",
    {
      method: "POST",
      headers: {
        Authorization: `Bearer ${token}`,
        "Content-Type": "application/json",
      },
      body: JSON.stringify(taskData),
    }
  );
  return await response.json();
}

// 获取检测任务进度
async function getCheckProgress(token, taskId) {
  const response = await fetch(
    `http://localhost:8000/api/tool/website-check/progress/${taskId}`,
    { headers: { Authorization: `Bearer ${token}` } }
  );
  return await response.json();
}

// 推送URL到百度
async function pushToBaidu(token, urls) {
  const response = await fetch(
    "http://localhost:8000/api/tool/baidu-push/push",
    {
      method: "POST",
      headers: {
        Authorization: `Bearer ${token}`,
        "Content-Type": "application/json",
      },
      body: JSON.stringify(urls),
    }
  );
  return await response.json();
}

注意事项

1. 任务并发: 同时运行多个检测任务可能会影响性能。
2. 超时设置: 检测任务默认超时时间为 30 秒，可根据需要调整。
3. 频率限制: 向搜索引擎提交 URL 时请注意频率限制，避免被屏蔽。
4. XWiki 配置: 使用 XWiki 同步功能前，需要先配置 XWiki 服务连接信息。
5. 链接完整性: 检测工具会递归检查所有链接，确保网站内部链接的完整性。
6. 结果缓存: 检测结果会缓存一段时间，避免重复检测。

相关文档

• 数据模型参考
• 内容模块 API
• 统计模块 API
• API 概览