你好，我想象中整体流程大概是这样的，请看是否适合：

1. Web Clipper HTML 转换 Markdown
2. 列出笔记本，让用户选择存放到某个笔记本下
3. 上传资源文件，思源会生成 ID 附加到文件名后面
4. 创建文档，这一步需要修改之前的 Markdown 中的资源文件链接为上一步返回的路径

接口端点、参数和返回值

• 端点：http://127.0.0.1:6806

• 均是 POST 方法，目前不需要验证

• 需要带参的接口，参数为 JSON 字符串，放置到 body 里，标头 Content-Type 为 application/json

• 返回值

  {
    "code": 0,
    "msg": "",
    "data": {}
  }
  • code：非 0 为异常情况
  • msg：正常情况下是空字符串，异常情况下会返回错误文案
  • data：可能为 {}、[] 或者 NULL，根据不同接口而不同

列出笔记本

• /api/notebook/ls

• 不带参

• 返回值

  {
    "code": 0,
    "msg": "",
    "data": {
      "files": [
        "F:\\SiYuan\\data/思源笔记用户指南",
        "F:\\SiYuan\\data/测试笔记本"
      ]
    }
  }
  • files：笔记本路径，截取最后一个 / 后面的字符串即笔记本名称

上传资源文件

• /api/asset/upload

• 参数为 HTTP Multipart 表单

  • assetsDirPath：资源文件存放的文件夹路径，实参有以下三种情况

    1. "/assets/"：工作空间 assets 文件夹
    2. "/测试笔记本/assets/"：测试笔记本下的 assets 文件夹
    3. "/测试笔记本/foo/assets/"：测试笔记本下 foo 文件夹下的 assets 文件夹

    建议用第三种，其中文件夹 foo 是创建文档时的文件夹，如果没有文件夹的话就是第二种情况。

  • file[]：上传的文件列表

• 返回值

  {
    "code": 0,
    "msg": "",
    "data": {
      "errFiles": [""],
      "succMap": {
        "foo.png": "assets/foo-20210719092549-9j5y79r.png"
      }
    }
  }
  • errFiles：处理时遇到错误的文件名
  • succMap：处理成功的文件，key 为上传时的文件名，value 为 assets/foo-id.png，用于将已有 Markdown 内容中的资源文件链接地址替换为上传后的地址

通过 Markdown 创建文档

• /api/filetree/createDocWithMd

• 参数

  {
    "notebook": "测试笔记本",
    "path": "/foo/bar.sy",
    "markdown": ""
  }
  • notebook：笔记本名称
  • path：文档路径，需要以 / 开头并以 .sy 结尾，中间使用 / 分隔层级
  • markdown：GFM Markdown 内容

• 返回值

  {
    "id": "文档 ID"
  }

我参数传错了？

表单中文件字段的 name 是 file[]。

@DiamondYuan API 鉴权 #2537