API 概览
所有端点均为 GET,无认证、无请求体。参数通过查询字符串(或 /og 的路径段)传递。
基础地址
https://og.159499.xyz端点清单
| 方法 | 路径 | 说明 | 响应类型 |
|---|---|---|---|
| GET | /og | 渲染图像(默认 base 模板) | image/svg+xml 或 image/png |
| GET | /og/:template | 渲染指定模板的图像 | image/svg+xml 或 image/png |
| GET | /templates | 模板清单 + 字段元数据 | application/json |
| GET | /fonts | 字体家族 / 注册信息 / 回退栈 | application/json |
| GET | /healthz | 健康检查 | application/json |
内容协商
- 图像端点:
format=svg(默认)或format=png。 - 成功响应为
image/*;失败响应一律为application/json(见错误契约)。 调用方只需看Content-Type就能判断成败,无需解析图片字节。
幂等与缓存
同一 URL(含全部 query)渲染结果相同,且会被 边缘缓存 命中(X-Cache: HIT)。 调试时加 debug=1 可绕过缓存(Cache-Control: no-store)。