首页
学习
活动
专区
圈层
工具
发布
社区首页 >专栏 >「媒体处理工具集」接口功能详解|数据鱼API

「媒体处理工具集」接口功能详解|数据鱼API

原创
作者头像
用户12862874
发布于 2026-11-20 22:00:12
发布于 2026-11-20 22:00:12
80
举报

接口简介

「媒体处理工具集」(media)是数据鱼API平台提供的媒体文件与站点图标处理接口,Base 路径 /api/media,共 4 个端点。它提供的是 EXIF 读取、SVG 源码压缩与站点图标地址推导这类工具能力,属于媒体处理库,而不是按媒体类型、地区或关键词检索内容的查询接口。

四个端点分工明确:exif 面向图片元数据,svg-minify 面向矢量图源码,favicon 面向站点图标地址,ping 用于存活探测。业务端点的输入都是字符串参数,输出统一为 JSON,不涉及文件上传、二进制下载或转码队列,结果由数据鱼API在服务端计算后一次性返回,调用方拿到后自行决定存储与展示方式。

接口文档对三个业务端点的说明较简,响应示例只展示单次调用的结果,未展开字段语义与边界条件。本文按文档口径整理参数与返回,并把文档未写明、但调用时容易踩到的差异单独列出,便于在接入前评估能力是否符合预期。

端点总览

方法

路径

说明

鉴权

GET

/api/media/ping

健康检查,返回版本与服务器时间

否

GET

/api/media/exif

读取图片 EXIF 信息,当前返回服务端文件访问说明

是

GET

/api/media/svg-minify

压缩 SVG 源码,去除注释与多余空白

是

GET

/api/media/favicon

由站点地址推导标准 favicon 路径

是

通用约定

  • 鉴权:受保护端点使用 X-API-Key 请求头或 ?api_key= 查询参数;缺失返回 4011,无效返回 4013,ping 免鉴权。
  • 请求方式:文档声明 GET 与 POST 均可,POST 支持 JSON body 或表单,参数名与 query 一致;文档中的示例全部使用 GET 加 query string。
  • 响应结构:统一为 code、msg、data 三段,code 为 0 表示成功;缺少必填参数返回 4001。
  • 依赖异常:上游不可用时返回 5031/5032,不会以占位图片或伪造元数据顶替,调用方应把空结果与“能力未实现”区分开。

核心端点详解

EXIF 读取 exif

接收一个图片地址参数,返回读取结果或能力说明。

参数

类型

必填

默认

说明

url

string

否

—

待处理的图片地址

文档示例的响应只有一个 note 字段,内容为本地 EXIF 读取需要服务端文件访问权限。这意味着当前端点不会下载远程图片再解析,也不会返回相机型号、拍摄时间、GPS 等标签表;它更像一个能力说明入口。需要真实标签数据时,应把图片落到服务端可访问的路径,并使用具备文件读取能力的实现,而不是把 URL 当作本地文件路径。

代码语言:javascript
复制
GET /api/media/exif?url=目标图片地址&api_key=YOUR_KEY

SVG 压缩 svg-minify

接收 SVG 源码,返回压缩后的字符串。

参数

类型

必填

默认

说明

svg

string

否

—

待压缩的 SVG 源码,文档未限定长度与格式

返回字段 minified 是压缩后的 SVG 文本,而不是状态码。文档示例中它显示为 "1",是因为示例把 svg 传成了 1,输出自然就是 1;不要据此认为接口返回的是数字标记。

压缩规则是文本级的:删除注释、去掉标签之间的空白、把连续空白折叠为单个空格并去除首尾空白。它不做路径简化、属性重写或 ID 去重,也不会校验 XML 是否合法;因此对格式混乱的输入仍会原样输出压缩后的文本。

代码语言:javascript
复制
GET /api/media/svg-minify?svg=%3Csvg%20viewBox%3D%220%200%2010%2010%22%3E%3Cpath%20d%3D%22M0%200h10v10z%22/%3E%3C/svg%3E&api_key=YOUR_KEY

站点图标 favicon

接收站点地址,返回域名与标准图标地址。

参数

类型

必填

默认

说明

url

string

否

—

站点地址,可带协议,也可只传域名

返回 domain、favicon_url、note 三个字段。实现方式是从传入地址中取主机名,再拼上固定的 /favicon.ico 路径,note 明确说明返回的是标准路径。它不会抓取页面 HTML 去解析 <link rel="icon">,也不会探测图标是否真的存在,所以对把图标放在其他路径、或用 PNG/SVG 图标的站点,返回地址可能无法访问。

代码语言:javascript
复制
GET /api/media/favicon?url=example.com&api_key=YOUR_KEY

健康检查 ping

参数

类型

必填

默认

说明

无

—

—

—

不接收业务参数

返回 version 与 time,适合负载均衡探活与接入联调。该端点不依赖数据表或外部服务,响应成功只代表进程可用,不代表 exif、svg-minify 等能力均可用。

数据与限制

  • 端点规模:4 个端点,其中 3 个业务端点、1 个健康检查;没有批量接口,多文件需循环调用。
  • 输入形式:url 与 svg 都是字符串参数,文档未给出长度上限;超长 SVG 建议在客户端先做一次压缩再提交。
  • EXIF 现状:响应只含说明字段,不含标签表;不支持上传文件,也没有 file、path 一类参数。
  • SVG 压缩:规则为去注释、去标签间空白、折叠空白、去首尾空白,属于轻量文本处理。
  • 图标推导:只按标准 /favicon.ico 路径拼接,不解析页面、不探测可用性、不做缓存。
  • 结果校验:三个端点都返回 200 与 code=0 包裹的结果,业务失败不一定体现为 HTTP 错误,调用方要读取 data 内容再判断。

典型使用场景

  • SVG 资源瘦身:设计稿导出的图标含大量注释与缩进,上传 CDN 前调用 svg-minify 压缩源码,减少传输体积。
  • 站点图标占位:后台录入站点域名后调用 favicon 生成标准图标地址,作为列表项的首屏占位,加载失败时回退到默认图。
  • 接入前能力探测:用 exif 的说明字段确认服务端是否具备本地文件访问条件,再决定是否把 EXIF 解析放进业务流程。

注意事项

  • 文档把 url 与 svg 标为“否”(非必填),但实现会在参数为空时返回 4001,调用时应始终传入非空值,不要依赖默认值。
  • exif 当前不返回任何 EXIF 标签,不能用它做隐私审计或拍摄信息展示;需要这类能力时应先确认服务端是否开放本地文件读取,或改用本地解析库。
  • svg-minify 只做文本压缩,不做安全过滤:脚本、事件属性、外部引用等危险内容会原样保留,渲染前必须按场景做净化。
  • SVG 压缩会折叠文本节点中的连续空白,对依赖空格排版的 <text> 元素可能改变显示效果,压缩后应做视觉比对。
  • favicon 返回的是推导地址而非可用性保证,目标站点未在根路径放置图标时会 404;传入不带协议的裸域名时,domain 可能回显原始输入而非规范主机名。
  • 数据鱼API的媒体工具端点不提供文件存储与转码,调用方不要把大文件或敏感图片交给接口处理,也不要把返回地址长期当作稳定资源。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

目录
  • 接口简介
  • 端点总览
  • 通用约定
  • 核心端点详解
    • EXIF 读取 exif
    • SVG 压缩 svg-minify
    • 站点图标 favicon
    • 健康检查 ping
  • 数据与限制
  • 典型使用场景
  • 注意事项
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档