TouchGal Docs

独立脱敏 Galgame Metadata API

GET /v1/health

健康检查

返回 API 进程是否存活,不访问 PostgreSQL、Redis 或源数据库。适合负载均衡的轻量存活探针。

接口基础信息

接口名称

健康检查

请求方法

GET

请求路径

/v1/health

鉴权

无需 API token。

请求参数

No parameters

该接口无 header、path、query 或 body 参数。

请求示例

业务接口不要在不可信浏览器环境暴露 token。示例 base 取自 NUXT_PUBLIC_API_BASE_URL,同源相对路径会自动拼接当前域名。

curl
curl "https://developer.touchgal.com/api/v1/health"

返回状态码与响应示例

200

OK

API 进程已响应。该结果只证明 HTTP 进程存活,不代表数据库和 Redis 可用。

application/json
{
  "success": true,
  "data": {
    "status": "ok",
    "version": "v1"
  }
}

返回内容解释

success
固定为 true,表示请求成功。
data.status
当前服务状态。
data.version
当前公开 API 主版本。