开放平台

字体管理接口

# 1 分页查询字体信息列表接口

简要描述

  • 获取项目字体列表

请求 URL

  • /api/font/listPage

请求方式

  • GET

参数

  • QueryParams
参数名 必选 类型 说明
queryName 否 string 查询字符串
pageSize 否 int 每页显示数量，默认值为 20
pageNum 否 int 第几页数据，默认值为 1
fontType 否 string 不填是包含所有，可用值：TTF，SHX （区分大小写）

返回示例

{
    "msg": "success",
    "code": 0,
    "data": {
        "total": 1,
        "pageSize": 10,
        "pageNum": 1,
        "rows": [
            {
                "id": "10001",
                "name": "simsun.ttf",
                "createBy": 0,
                "creator": "",
                "ownerName": "SDK超级用户",
                "createTime": 1704163089000,
                "updateBy": "",
                "updater": "",
                "updateTime": "",
                "fileId": "1000005",
                "size": 12320392,
                "fontVersion": "Version 5.16",
                "defaultFlag": "YES",
                "source": "SYSTEM",
                "extraInfo": ""
            }
        ]
    }
}

返回参数说明

参数名 类型 说明
id long 字体 Id
name string 字体名称
createBy int 字体创建用户 id
creator string 字体创建用户名称
createTime string 创建时间
updateBy int 字体更新用户 id
updateTime string 更新时间
ownerName string 字体所属用户名称
updater string 字体更新用户名称
fileId long 字体文件 Id
size long 字体文件大小，单位：byte
fontVersion string 字体版本
defaultFlag string 是否为默认字体，YES：是默认字体,NO：不是默认字体
source string 字体来源：SYSTEM，系统创建；USER，用户创建 等；
extraInfo string 字体额外信息，内容不固定

备注

# 2 查看字体详情信息接口

简要描述

  • 修改指定文档名称信息。

请求 URL

  • /api/font/{id}

请求方式

  • GET

请求示例

/api/font/10001

参数

参数名 必选 类型 说明
id 是 long 字体 Id

返回示例

{
    "msg": "success",
    "code": 0,
    "data": {
        "createBy": 0,
        "createTime": 1704163089000,
        "id": 10001,
        "projectId": 1000,
        "type": "TTF",
        "source": "SYSTEM",
        "fileId": 1000005,
        "name": "simsun.ttf",
        "fontVersion": "Version 5.16",
        "defaultFlag": "YES"
    }
}

返回参数说明

参数名 类型 说明
createBy int 创建人
createTime timestamp 创建时间戳
id string 字体 id
projectId string 项目 id
type string 字体类型
source string 字体来源：SYSTEM，系统创建；USER，用户创建 等；
fileId long 字体文件 Id
name string 字体名称
fontVersion string 字体版本
defaultFlag string 是否为默认字体，YES：是默认字体,NO：不是默认字体

备注

# 3 删除字体接口

简要描述

  • 删除字体文件

请求 URL

  • /api/font/delete

请求方式

  • POST

请求参数示例

{
	"ids": ["1234", "1234"]
}

参数

参数名 必选 类型 说明
ids 是 array 删除字体 ID 列表

返回示例

  {
    "msg": "操作成功",
    "code": 0,
    "data": true
  }

返回参数说明

参数名 类型 说明

备注

# 4 字体下载接口

简要描述

  • 支持单个或者多个字体文件下载，多个字体文件将以 zip 压缩的方式返回。

请求 URL

  • /api/font/download

请求参数示例

  • GET

参数

{
	"ids": ["1234", "1234"]
}

参数

参数名 必选 类型 说明
ids 是 array 删除字体 ID 列表

返回参数说明

字体文件文件流

备注

# 5 以 GZIP 压缩格式下载单个字体接口

简要描述

  • 获取字体文件 GZIP 压缩之后的内容

请求 URL

  • api/font/gzip

请求方式

  • GET

参数

参数名 必选 类型 说明
fileId 是 long 字体文件 ID，字体文件 id 可以从文档详情接口或者字体列表接口等途径获取

返回示例

字体文件的 GZIP 压缩后的文件流

返回参数说明

参数名 类型 说明

备注

# 6 字体文件上传接口

简要描述

  • 上传项目字体文件（支持 SHX、TTF、OTF、TTC 等字体文件）

请求 URL

  • /api/font/upload

请求方式

  • POST

参数

  • Body FormData ，请求头的 content-type 必须是 multipart/form data
参数名 必选 类型 说明
file 是 filestream 字体文件
id 是 string 字体文件唯一 id，前端生成，如“56321456”
uploadId 是 string 文件上传唯一标识，前端生成，如“4556231242523”

返回示例

  {
    "msg": "操作成功",
    "code": 0,
    "data": {
      "id": "11235654987985658",
	  "fileId": "13235654987985658",
    }
  }

返回参数说明

参数名 类型 说明
id long 字体的 Id
fileId long 字体文件的 Id

备注

# 7 获取项目字体替换规则配置

简要描述

  • 获取项目字体替换规则配置列表

请求 URL

  • /api/project/setting?option=alternateFontList

请求方式

  • GET

请求示例

  • /api/project/setting?option=alternateFontList

参数

参数名 必选 类型 说明
option 是 string 对于项目字体替换规则配置，值为 “alternateFontList”

返回示例

  {
    "code": 0,
    "msg": "success",
    "data": {
        "setting": [
            {
                "tarFont": "456.ttf",
                "srcFont": "123.ttf"
            },
            {
                "tarFont": "147.shx",
                "srcFont": "123.shx"
            }
        ]
    }
  }

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data object 数据对象
setting array 对象数组
srcFont string 原字体名称，即被替换的字体名称
tarFont string 替换字体名称，即替换原字体的字体名称

备注

原字体与替换字体文件名后缀请保持一致。大字体只能用大字体替换，小字体只能用小字体替换，符号形仅用于图纸显示不能用于替换其他字体。

# 8 设置项目字体替换规则

简要描述

  • 设置项目字体替换规则；
  • 当原字体（srcFont）不存在时，使用设置的替换字体（tarFont）进行替换；
  • 原字体与替换字体文件名后缀请保持一致。大字体只能用大字体替换，小字体只能用小字体替换，符号形仅用于图纸显示不能用于替换其他字体

请求 URL

  • /api/project/setting

请求方式

  • POST

请求示例

  • /api/project/setting
{
    "option": "alternateFontList",
    "setting": {
        "configs": [{
                "tarFont": "456.ttf",
                "srcFont": "123.ttf"
            }, {
                "tarFont": "147.shx",
                "srcFont": "123.shx"
            }
        ]
    }
}

参数

  • Body ，application/json
参数名 必选 类型 说明
option 是 string 对于项目字体替换规则配置，值为 “alternateFontList”
setting array 对象
configs array 配置对象数组
srcFont string 原字体名称，即被替换的字体名称
tarFont string 替换字体名称，即替换原字体的字体名称

返回示例

  {
    "code": 0,
    "msg": "success",
    "data": true
  }

返回参数说明

参数名 类型 说明
code int 返回参数
msg string 返回消息
data object 数据对象

备注

原字体与替换字体文件名后缀请保持一致。大字体只能用大字体替换，小字体只能用小字体替换，符号形仅用于图纸显示不能用于替换其他字体。

文件管理