跳到主要内容

Upload Image API (可选API)

版本要求

该 API 从 v9 版本开始支持,目前用于 Markdown 文档编辑时上传图片。

MethodAPI描述
POST/{context}/{docId}/file/image上传图片到业务系统

功能说明:
当用户在 Markdown 编辑器中插入图片时,zOffice Server 会通过此 API 将图片文件上传到业务系统。业务系统需存储图片并返回一个使用环境可访问的图片 URL,该 URL 将被写入 Markdown 内容中(如 ![](url) 格式)。

请求​

参数必须位置说明类型默认值
docId是Path当前编辑的文档 IDstring
Content-Type是Header固定为 multipart/form-datastring
file是Body (form data)图片文件本身,MIME 类型必须以 image/ 开头(如 image/png、image/jpeg)multipartfile

请求示例:

POST http://172.16.52.223/v2/context/484/file/image
Content-Type: multipart/form-data

------boundary
Content-Disposition: form-data; name="file"; filename="screenshot.png"
Content-Type: image/png

<图片二进制数据>
------boundary--

响应​

成功响应(200):

业务系统需返回包含图片可访问 URL 的 JSON。

{
"url": "https://your-domain.com/images/screenshot.png"
}

图片删除策略​

当用户在 Markdown 编辑器中删除图片引用(![](url))时,zOffice Server 不会向业务系统发送删除请求。仅从文档内容中移除对应的 Markdown 图片语法,图片文件的生命周期由业务系统自行管理。

限制说明​

集成方式限制

此 API 当前支持标准集成和前端集成方式。
前端SDK集成方式暂不支持,调用时将返回 HTTP 501。

配置说明​

业务系统接入前,需在 zOffice Server 管理控制台 中开启 MD 图片上传功能:

  1. 进入 管理控制台 → 集成应用
  2. 编辑对应的三方应用,勾选 「开启MD图片上传」 开启MD上传图片
  3. 保存配置

该开关默认关闭。未开启时,前端上传图片请求将返回 HTTP 403。