API 参考读取 API

指定周排行

按 year / week 取指定周的榜单,缺省最近一个完整周。

GET/api/v1/rankings/weekly
GET
/api/v1/rankings/weekly

year / week 都不传时取最近一个完整周期,响应里的 period 会回显它——不回显的话,调用方无从知道自己拿到的到底是哪一期,而「静默地排了另一周」正是这条路要避免的(§5.1)。

榜单部分沿用现有的 Rankings(trending + byRelativeGrowth),并额外带上 period 回显。响应带 ETag 与 Cache-Control,可以放心地条件请求。

Authorization

bearerAuth
AuthorizationBearer <token>

Authorization: Bearer <key>。key 由控制台自助签发,或管理员在 /dashboard 代签

In: header

Query Parameters

year?integer

四位年份。缺省为最近一个完整周期

week?integer

ISO 周序号 1–53,给了它 year 才有意义

Range1 <= value <= 53
limit?integer

返回条数上限,缺省 100

Range1 <= value

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/rankings/weekly"
{  "period": "week",  "year": 0,  "week": 0,  "month": 0,  "trending": [    {      "name": "string",      "fullName": "string",      "description": "string",      "stars": 0,      "delta": 0,      "relativeGrowth": 0,      "tags": [        "string"      ],      "ownerId": 0,      "createdAt": "2019-08-24T14:15:22Z",      "logo": "string",      "iconUrl": "string",      "avatar": "string",      "anomaly": {        "kind": "star_cliff",        "severity": "down",        "title": "string"      }    }  ],  "byRelativeGrowth": [    {      "name": "string",      "fullName": "string",      "description": "string",      "stars": 0,      "delta": 0,      "relativeGrowth": 0,      "tags": [        "string"      ],      "ownerId": 0,      "createdAt": "2019-08-24T14:15:22Z",      "logo": "string",      "iconUrl": "string",      "avatar": "string",      "anomaly": {        "kind": "star_cliff",        "severity": "down",        "title": "string"      }    }  ]}