接口简介
「品牌 Logo 生成」是数据鱼API平台提供的几何底 Logo 拼装接口,Base 路径 /api/brand-logo,共 3 个端点:按输入文本、形状与配色参数,本地拼装一枚 200×200 的几何底 Logo,返回 SVG 源码与 base64 Data URI 两种形态。形状支持圆形、方形、圆角方形与六边形四种,主色支持七种预设色。图形中央展示文本的前两个字符(自动转大写),其余字符不参与渲染。
生成逻辑为固定模板填充:底形路径加居中文本元素,不调用第三方图形服务,也没有图片上传链路。返回的 SVG 使用标准命名空间声明,可直接嵌入网页或转存为图片文件。数据鱼API 的该接口适用于占位图形、演示数据等对图形精细度要求不高的场景。
type 参数控制返回形态:json 返回结构化数据(含 svg 与 base64 字段),svg 直接输出图形文档本体,便于由 img 标签直链展示。
端点总览
方法 路径 说明 鉴权
GET /api/brand-logo/ping 健康检查,返回可选形状与颜色清单 免鉴权,实测不带 Key 可用
GET /api/brand-logo/generate 生成 Logo(查询串传参) 是
POST /api/brand-logo/generate 生成 Logo(表单或 JSON body 传参) 是
通用约定
鉴权:数据鱼API 全站统一的 X-API-Key 请求头或 ?api_key= 查询参数;4011/4013 全站通用,不再展开。
响应为统一 code/msg/data 结构;generate 端点对非法参数不报错,按默认值回退处理。
ping 免鉴权实测可用,返回 version 与 options(shapes、colors 的完整取值清单)。
核心端点详解
generate 生成 Logo
参数 类型 必填 默认 说明
text string 否 LOGO 展示文本,取前 2 个字符大写渲染
shape string 否 circle circle / square / rounded / hexagon
color string 否 blue blue / red / green / purple / orange / black / indigo
type string 否 json json 返回结构化数据;svg 直接输出图形文档
返回字段要点:svg 为完整 SVG 源码字符串;base64 为带 data:image/svg+xml 头的 Data URI;params 回显本次请求参数。type=svg 时响应体即 SVG 文档本身。
GET /api/brand-logo/generate?text=Hi&shape=hexagon&color=purple&api_key=YOUR_KEY
{
"code": 0,
"msg": "success",
"data": {
"svg": "…",
"base64": "data:image/svg+xml;base64,PHN2Zy…",
"params": {"text": "Hi", "shape": "hexagon", "color": "purple"}
}
}
数据与限制
画布固定 200×200(viewBox 100×100),无尺寸、字体、透明度等自定义参数。
文本只渲染前 2 个字符并转大写:hello 显示 HE;缺省或空文本回退 LOGO,显示 LO。
形状与颜色为预设枚举,取值以 ping 返回的 options 为准。
纯本地生成,无外部依赖,无缓存标记,同参数重复调用结果一致。
典型使用场景
原型与演示项目批量生成占位标识。
后台管理系统按项目名生成默认图标。
教学示例中演示 SVG 拼装与 Data URI 的用法。
注意事项
非法 shape / color 不返回 4003,而是静默回退默认值(circle / blue),调用方需自行校验入参合法性。
svg 与 base64 字段内含 SVG 命名空间声明等标准属性,集成时按完整字段内容使用,不要截断拼接。
API.md 响应示例中 params 字段的值与示例请求不对应,属于示例陈旧;实测 params 与本次请求一致,以实测为准。
生成结果为模板拼装的装饰图形,不构成品牌设计或商标使用建议。
本接口随数据鱼API 平台统一升级,形状与颜色的可用取值以 ping 返回的 options 清单为准。