API 参考

rpicx 公开 API 文档

基础信息

默认地址	`https://api.tor.hk/v1`
数据格式	JSON
OpenAPI	`GET /openapi.json`

端点列表

`GET /v1/health`

认证：无

功能：服务健康检查，返回当前图片总数和运行状态。

响应 200：

{
  "status": "ok",
  "image_count": 100000
}

`GET /v1/random`

认证：无

功能：从内存索引中随机选取一张图片，返回 302 重定向。

查询参数：

参数	类型	必填	说明
`category`	string	否	按分类过滤

成功 (302)：

Location: https://img.tor.hk/xxx.webp

无图片 (404)：

{ "success": false, "error": "No images available" }

`GET /v1/categories`

认证：无

功能：返回图片总数。

响应 200：

{
  "total_images": 100000,
  "categories": []
}

`GET /v1/stats`

认证：无（IP 限流 10 QPS，响应缓存 3 小时）

功能：返回服务聚合统计信息。

响应 200：

{
  "requests_total": 1000000,
  "requests_today": 5000,
  "avg_hour_requests": 200.0,
  "uv_today": 1200,
  "top_referer": [{ "name": "github.com", "count": 300 }],
  "top_ua": [{ "name": "Chrome", "count": 500 }],
  "status": { "code_200": 900000, "code_302": 50000, "code_404": 20, "code_429": 10, "code_500": 0 },
  "sync_count": 30
}

`GET /metrics`

认证：无

功能：Prometheus 指标暴露端点（text/plain）。

`GET /openapi.json`

认证：无

功能：返回 OpenAPI 3.0 规范文档（JSON）。