Skip to content

API 概览

所有端点均为 GET,无认证、无请求体。参数通过查询字符串(或 /og 的路径段)传递。

基础地址

https://og.159499.xyz

端点清单

方法路径说明响应类型
GET/og渲染图像(默认 base 模板)image/svg+xmlimage/png
GET/og/:template渲染指定模板的图像image/svg+xmlimage/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)。

如何阅读本参考

  • 渲染参数分两级:框架级width / height / format / theme / debug,对所有模板通用) 与模板级(由各模板的 fields 元数据声明)。详见 渲染接口 /og
  • 每个模板支持的字段见 模板字段参考,或运行时调 /templates 获取最新值。

基于 VitePress 构建 · 接口随代码演进,以线上 /templates 为准