接口简介
「APCA 对比度计算」是数据鱼API平台提供的颜色对比度计算接口,Base 路径 /api/apca-vision,共 2 个端点,实现 APCA(Accessible Perceptual Contrast Algorithm,可感知对比度算法)的简化口径 SAPC-8,并同步给出 WCAG 2.x 相对比率的对照值。它解决的是现代可访问性设计的度量问题:WCAG 的比率算法在深色主题与低亮度场景下判断偏差较大,APCA 基于感知亮度(按 2.4 次幂线性化后的三刺激亮度加权)给出 Lc 值,对同一组颜色能更贴近人眼的真实可读性。
调用方式极简:传入文字颜色与背景颜色两个十六进制色值,返回 APCA 的 Lc 对比度(保留两位小数)、按 Lc 绝对值划分的可读性档位、回显的两个输入色值,以及 WCAG 比率。档位划分覆盖从正文(Lc 90 起为正文首选、75 为正文下限)到内容文字、大号文字、非文字元素、装饰元素乃至不及格的完整梯度,客户端可直接把 rating 字段展示为设计规范结论。
计算在服务端即时完成,无外部依赖;三个位与六位十六进制(含省略 # 前缀)均可解析。黑字白底这一极端组合的实测输出为 Lc 108.74、WCAG 比率 21,可作为集成后的自检样例。
接口共 2 个端点:免鉴权的健康检查与核心的 calc 计算端点。
端点总览
方法 路径 说明 鉴权
GET /api/apca-vision/ping 健康检查(免鉴权) 免鉴权
GET /api/apca-vision/calc 计算 APCA 对比度与 WCAG 比率 需要
通用约定
鉴权使用 X-API-Key 请求头或 ?api_key= 查询参数,全站统一 Key:缺失返回 4011,无效返回 4013。响应为统一三段结构 {code, msg, data},code 为 0 表示成功。需要特别留意的是,本接口颜色解析失败时返回的自定义 code 为 400(Invalid hex color),不落入全站统一的 4002 口径,且 HTTP 状态仍为 200;集成方应以 code 是否为 0 而非 HTTP 状态判断成败。其余错误:4001 缺少参数、4004 目标不存在、5032 上游服务不可用。鉴权与响应结构为数据鱼API平台全站统一约定。
核心端点详解
对比度计算(GET /calc)
用途:对一组文字/背景颜色计算 APCA Lc 值、可读性档位与 WCAG 比率。
参数 类型 必填 默认 说明
text string 否 #000000 文字颜色,十六进制,支持三位(如 f00)与六位写法,# 前缀可省略
bg string 否 #FFFFFF 背景颜色,格式要求同上
返回字段要点:contrast 为 APCA 的 Lc 值,保留两位小数,深底浅字与浅底深字符号相反,比较强度时应取绝对值;rating 为按 Lc 绝对值划分的档位文案(Lc 90 正文首选、Lc 75 正文下限、Lc 60 内容文字下限、Lc 45 大号文字(18pt 起)下限、Lc 30 非文字与大标题下限、Lc 15 禁用/装饰元素下限,低于 15 判为对比度不足);txt_color 与 bg_color 回显输入色值;wcag_ratio 为 WCAG 2.x 相对比率,两端取大比小,便于向仍采用 WCAG 口径的团队交付。
请求示例:
GET /api/apca-vision/calc?api_key=YOUR_KEY&text=#1A1A1A&bg=#F5F5F5
响应示例(黑字白底实测口径):
{
"code": 0,
"msg": "success",
"data": {
"contrast": 108.74,
"rating": "Lc 90 - Preferred for body text",
"txt_color": "#000000",
"bg_color": "#FFFFFF",
"wcag_ratio": 21
}
}
健康检查(GET /ping)
免鉴权,无请求参数,返回版本号与服务器时间,用于探活与部署确认。
GET /api/apca-vision/ping
数据与限制
算法口径为 SAPC-8 简化实现:sRGB 通道按 2.4 次幂线性化后以 0.2126729/0.7151522/0.0721750 加权合成亮度,低于 0.022 的亮度做软限幅;亮背景与暗背景分别采用不同指数组合,结果乘 100 得 Lc。
两色亮度差小于 0.0005 时 Lc 直接判 0,档位为对比度不足。
色值解析仅支持 3 位与 6 位十六进制,不支持 rgb()、HSL 等其他颜色格式;非法输入返回自定义 code 400。
wcag_ratio 按整数精度返回样例值(如 21),与 APCA 的 Lc 无换算关系,两者是并行的两套口径。
典型使用场景
设计系统与组件库的自动化检查:在 CI 或Storybook流程里逐对校验前景/背景色是否达到正文档位。
深色主题适配:深底浅字的场景下用 APCA 口径替代单一 WCAG 比率做配色决策。
可访问性审计工具:同时展示 Lc 与 wcag_ratio,兼顾新口径与现行规范汇报。
注意事项
文档与实现存在明显差异,以实测为准:文档称 calc「无请求参数」,实现实际接收 text 与 bg 两个可选参数并有默认值(黑字白底);未传参也会返回默认组合的结果,容易误读为固定值,集成时务必显式传参。
颜色非法时返回 code 400 而非 4002,且 HTTP 状态为 200,统一错误处理逻辑需要为本接口保留该分支。
contrast 的符号反映明暗方向(正负对应背景更亮或更暗),判断是否达标请使用绝对值,rating 字段已按绝对值判定,可直接采信。
APCA 档位对应的是推荐用途(正文、大字号、非文字等),不同版本算法草案的阈值存在差异,作为设计规范执行时应固定以本接口返回的 rating 文案为准。
本接口属于数据鱼API平台开发工具类接口,鉴权与响应结构与其他接口一致。