接口简介
数据鱼API平台的「ASCII 艺术字生成」接口用于把短文本转换成 ASCII 字符画(block letter),Base 路径 /api/asciiart,共 3 个端点。调用方传入一段文本,接口逐字符查内置点阵字体,把每个字符展开为 5 行 5 列的字模,横向拼接后返回整幅字符画,字符之间以两列空格分隔,行之间以换行符连接。
引擎是纯 PHP 实现,不依赖图形库、不访问外部资源,输出就是一段带换行的等宽文本,放在
等等宽容器里即可展示。由于没有随机因素,同一输入永远得到同一输出,适合在 CI 日志、终端横幅、README 标题等场景生成固定的文本标记。
需要特别说明的是内置字体的覆盖范围:基础点阵只收录了字母 A 至 I、数字 0 与 1 以及空格共 12 个字模。输入会被统一转为大写,命中字模的字符正常渲染,未收录的字符(J 至 Z、中文、符号等)会渲染为 5×5 的空白块,占位但不显示。这一点使其更适合作为联调样本与受控场景的字形输出,而不是通用字体渲染服务。
端点总览
方法 路径 说明 鉴权
GET /api/asciiart/ping 健康检查 需要
POST /api/asciiart/generate 生成 ASCII 字符画 需要
GET /api/asciiart/generate 生成 ASCII 字符画(查询参数版) 需要
通用约定
鉴权使用数据鱼API 全站统一 Key,通过 X-API-Key 请求头或 ?api_key= 查询参数传递;缺失返回 4011,无效返回 4013。响应为 {code, msg, data} 结构,4001 表示缺少 text 参数。generate 同时支持 GET 与 POST,POST 时可用 JSON body 或表单传参,参数名与 query 一致。
核心端点详解
字符画生成 generate(POST)
将文本转换为 ASCII 字符画,推荐用 POST 传较长文本。
参数 类型 必填 默认 说明
text string 是 - 待转换文本,命中字模的字符渲染,其余渲染为空白块
返回 data.art 为 5 行字符画,行内按字符顺序横向拼接。每个字模 5 列宽,字符间附加 2 列间隔,总宽度约为 7 倍字符数。
POST /api/asciiart/generate
Content-Type: application/json
X-API-Key: YOUR_API_KEY
{"text": "HI1"}
字符画生成 generate(GET)
语义与 POST 版完全一致,适合拼 URL 快速调用。
参数 类型 必填 默认 说明
text string 是 - 待转换文本,作为查询参数传递
GET /api/asciiart/generate?text=HI1
X-API-Key: YOUR_API_KEY
数据与限制
字体仅收录 A–I、0、1 与空格:J–Z、小写(自动转大写后仍不命中)、中文、标点一律渲染为空白块,且不报错。
输出恒为 5 行;单行长度随输入字符数线性增长,无文档级长度上限,建议控制在可展示宽度内。
纯内存计算,无缓存、无外部依赖,无上游不可用类错误。
典型使用场景
插件联调样本:参数只有一个且行为确定,常用作鉴权与响应结构验证的最小用例。
终端与日志横幅:在部署脚本或 CI 输出里生成固定标记,便于肉眼定位阶段分隔。
等宽排版装饰:为 README、代码注释块生成简单的字符标题(限 A–I 与 0、1 组合)。
注意事项
健康检查 ping 在文档中标注免鉴权,实测仍要求携带 API Key,不带 Key 返回 4011。
未收录字符静默渲染为空白而非报错,拼错单词时输出只是「缺一块」,排错时先确认字符是否在字模表内。
输入统一转大写,但数据鱼API 字模表本身没有小写与扩展字符;不要假设「大写化之后就能渲染任意字母」。
多字节字符按 PHP 单字节方式逐字节处理,中文等字符会产生连续空白块;传中文前请确认展示宽度预算。