GET公开接口

获取项目公开信息

提供项目基础信息,通常用于客户端启动时初始化展示。

URL

/api/v1/public/{projectKey}

鉴权方式

无需鉴权

请求参数

Path 参数

名称类型必填说明
projectKeystring项目主键 project_key(大小写不敏感)

Query 参数

名称类型必填说明
platformwindows | linux | macos | ios | android | web | others客户端平台声明(等价于 `x-verhub-platform` 请求头,优先级低于请求头)。 仅用于请求统计,不影响接口返回内容。
platform_versionstring客户端系统版本明细(等价于 `x-verhub-platform-version` 请求头,优先级低于请求头)。 仅用于请求统计,不影响接口返回内容。
localestring语言偏好。命中项目注册的语言(主标签或同义标签,大小写不敏感)且该语言的 译文填了对应字段时,`name` / `description` 返回译文,`locale` 字段标出实际语言。 没提本参数、语言未注册、或该语言的译文把字段留空,都回落项目自身的值且 `locale` 为 `null`。两个字段各自独立回落。

Header 参数

名称类型必填说明
x-verhub-platformwindows | linux | macos | ios | android | web | others客户端平台声明,仅用于请求统计,不影响接口返回内容。 识别优先级:本请求头 > query 参数 `platform` > 请求体 `platform` 字段 > User-Agent 推断。 取值大小写不敏感,无法识别时统计为 OTHERS。 具体系统版本请用 `x-verhub-platform-version` 单独提交;若把版本混在本字段里 (如 `Windows 11`、`ubuntu 24.04`),服务端会拆开,平台与版本分别入库。 建议 SDK 显式声明本请求头:服务端调用的 User-Agent 往往不可靠。
x-verhub-platform-versionstring客户端系统版本明细,仅用于请求统计,不影响接口返回内容。 自由文本,如 `11`、`ubuntu 24.04`、`26`;超过 32 字符视为无效直接丢弃。 识别优先级:本请求头 > query 参数 `platform_version` > 请求体 `platform_version` 字段 > 从 `platform` 中拆出的版本 > User-Agent 推断。

该接口无需请求体。

响应示例

200 响应

{
  "id": "verhub",
  "project_key": "verhub",
  "name": "Verhub",
  "description": "版本管理平台",
  "repo_url": "https://github.com/example/verhub",
  "author": "octocat",
  "author_homepage_url": "https://github.com/octocat",
  "icon_url": "https://avatars.githubusercontent.com/u/1?v=4",
  "website_url": "https://verhub.dev",
  "docs_url": "https://docs.verhub.dev",
  "published_at": 1760000000,
  "optional_update_min_comparable_version": "1.0.0",
  "optional_update_max_comparable_version": "1.9.9",
  "stats_retention_days": 365,
  "aliases": [
    "verhub-old"
  ],
  "created_at": 1760000000,
  "updated_at": 1760000000
}
GET

Try It Out

请求 URL 预览

/api/v1/public/verhub?locale=en-US