Skip to content

路由端点 ​

Base URL 示例:http://localhost:3000

方法路径说明
GET/health进程健康状态 + 缓存统计
GET/openapi.jsonOpenAPI 文档
GET/v1/version导出版本元数据
GET/v1/manifest构建 manifest
GET/v1/continents洲列表
GET/v1/countries国家/地区列表
GET/v1/events项目列表
GET/v1/competitions比赛列表 / 过滤
GET/v1/competitions/:id比赛详情;当 token 为年份/国家/项目时返回集合
GET/v1/championships锦标赛(?type=)
GET/v1/championships/:id锦标赛详情
GET/v1/persons选手摘要
GET/v1/persons/:id选手详情
GET/v1/ranks/:region/:type/:event排名
GET/v1/results/:competitionId比赛成绩
GET/v1/results/:competitionId/:eventId按项目查成绩

查询参数 ​

/v1/competitions ​

参数示例含义
page / sizepage=2&size=50分页
countryBEISO2
year2023年份
month08与 year 组成的 YYYY-MM 切片
day13完整日期切片
event333举办过该项目的比赛

集合 ​

page 与 size 对锦标赛、选手、排名,以及带过滤的比赛集合均有效。

示例 ​

bash
curl 'http://localhost:3000/v1/competitions?country=BE&year=2023'
curl 'http://localhost:3000/v1/persons/2012PARK03'
curl 'http://localhost:3000/v1/ranks/world/single/333?page=1&size=50'
curl 'http://localhost:3000/v1/results/WC2023/333'

错误 ​

json
{
  "error": {
    "code": "NOT_FOUND",
    "message": "person '2012NOPE01' not found",
    "resource": "person",
    "id": "2012NOPE01"
  }
}

非官方项目。数据由 World Cube Association 所有并维护(worldcubeassociation.org/export/results)。