GET /v1/ready
就绪检查
检查 clean PostgreSQL 与 Redis 依赖是否可用,不触碰 TouchGal 主库。适合部署平台的 readiness probe。
接口基础信息
请求参数
No parameters该接口无 header、path、query 或 body 参数。
请求示例
业务接口不要在不可信浏览器环境暴露 token。示例 base 取自 NUXT_PUBLIC_API_BASE_URL,同源相对路径会自动拼接当前域名。
curl "https://developer.touchgal.com/api/v1/ready"返回状态码与响应示例
200
Ready
所有已配置的 readiness checks 均通过。
{
"success": true,
"data": {
"status": "ready",
"version": "v1"
}
}返回内容解释
success- 固定为 true,表示请求成功。
data.status- 当前服务状态。
data.version- 当前公开 API 主版本。
503
Not ready
readiness checks 未配置、超时,或 clean PostgreSQL/Redis 当前不可用。
{
"success": false,
"error": {
"code": "NOT_READY",
"message": "Service dependencies are not ready"
}
}返回内容解释
success- 固定为 false,表示请求失败。
error.code- 稳定错误码,可用于客户端分支处理。
error.message- 面向开发者的错误摘要,不包含内部 SQL、token、DSN 或其他敏感信息。