POST公开旧版GitHub资料卡PNG截图迁移vv1

GitHub 资料卡预览(旧版)

迁移自旧 GithubPreview:给一个 GitHub 仓库/用户链接,生成 1200x600 的资料卡 PNG(仓库星标/复刻/Issue/贡献者统计,或用户关注数/博客/简介),本地绘制、无需旧站内网服务。

/api/GithubPreview
在线调试
频率限制按方案
每日额度按方案
所需权限无

接口说明

迁移自旧 GithubPreview:给一个 GitHub 仓库/用户链接,生成 1200x600 的资料卡 PNG(仓库星标/复刻/Issue/贡献者统计,或用户关注数/博客/简介),本地绘制、无需旧站内网服务。

请求参数

请求体为 JSON;未在接口定义中列出的字段一般会被忽略,但个别 Provider 单独校验的接口仍可能拒绝未声明字段;已定义字段仍会做类型、长度与枚举校验。

字段类型说明
url*stringGitHub 仓库或用户链接,如 https://github.com/octocat/Hello-World
typestring旧返回格式参数;新平台统一返回 JSON
clearunion非空时跳过缓存,强制重新生成

返回参数

成功响应中 data 内的字段(不含信封的 code / message / meta)。未列出的字段可能随版本增加,请忽略未知字段。

请求示例

request.json
{
  "url": "https://github.com/octocat/Hello-World"
}

返回示例

response.json
{
  "code": 1,
  "data": {
    "kind": "repo",
    "repo": "Hello-World",
    "user": "octocat",
    "forks": 2100,
    "stars": 2500,
    "issues": 30,
    "contributors": 12
  },
  "message": {
    "base64": "<1200x600 PNG base64>",
    "contentType": "image/png"
  }
}

所有接口统一返回 { code, message, data, error_code?, details?, meta }。 成功 code = 1;失败 code 为唯一负数(如 -10001)并给出结构化 error_code, 错误码说明 →