📢 接口更新声明 · 2025 年 8 月 12日

Tanmer

发布于:2025-08-12


API 更新文档 — GET /api/v1/sites/:site_id/pages

变更内容

1. 新增参数 full_path_in
  • 说明:支持批量查询多个页面数据,不超过 50 个 full_path
  • 格式:多个路径以逗号分隔,如 /page1,/page1/page3,/page2
  • 示例
    GET /api/v1/sites/123/pages?full_path_in=/page1,/page1/page3,/page2
    
2. 新增参数 fields[pages]
  • 说明:指定返回的页面字段,支持多字段和嵌套字段。列表和详情可用
  • 格式:字段用逗号分隔,如 full_path, slug ,settings.thumb_url,template_variables.title。需要settings或者template_variables的字段需要同时传递include_details为true
  • 示例
    GET /api/v1/sites/123/pages?fields[pages]=name,full_path,slug
    

3. 新增缓存支持
  • 说明
    • 新增通过添加请求头 FROM_CACHE: y 使用缓存功能。
    • 若请求携带此请求头且缓存存在,则直接返回缓存结果,无需重新计算。
    • 缓存 key 由当前用户和请求参数组成,确保不同用户和请求参数独立缓存。
  • 使用示例
    curl -H "FROM_CACHE: y" http://your.api/v1/sites/123/pages?full_path_in=/page1
    

4. 新增 Webhook 支持
  • 用途:知识库设置,站点设置,文章内容变更时推送通知。
  • 事件示例
    • site_pages_events
    • site_settings_events
  • 示例负载
    {
      "site_id":462,
      "name":"【官网】探码科技",
      "hook_time":1754994215516,
      "event_name":"site_pages_events",
      "pages_updated_at":"2025-08-12T18:23:35.514+08:00"
    }
    
    {
      "site_id":462,
      "name":"【官网】探码科技",
      "hook_time":1754994929529,
      "event_name":"site_settings_events",
      "settings_updated_at":"2025-08-12T18:35:29.521+08:00"
    }
    

5. 修复
  • 验证码自动失效
  • 验证码错误输入超过 5 次后,验证码自动失效,需重新获取。
  • 翻页重复问题
  • 修复接口分页返回时,存在页面重复的 Bug,保证每页数据唯一且正确。
提交反馈