跳转到内容

Project(企划)

Project 是 Franchise 下的独立企划、产品线或世界观分支。

Franchise 关系数据和扩展字段会在公开契约稳定后补充。

主属性描述 Project 自身。本轮只记录全局稳定的最小字段。

FieldTypesupportedDescription
idstringkey 生成的稳定公开 ID;客户端应视为 opaque。
keystring全局唯一稳定 key,用于过滤和跨域引用。
namestring规范名称。

其他字段会在公开契约稳定后再补充。

公开 OpenAPI 规范是路由契约的事实来源。

MethodPath说明
GET/api/v1/projects获取 Project 列表。
GET/api/v1/projects/{key}key 获取单个 Project。

列表路由支持 cursor 分页:

QueryType说明
limitnumber每页数量;默认 100,最大 500
cursoropaque string上一页响应 meta.nextCursor 返回的 opaque cursor。

列表响应包含 meta.limitmeta.cursormeta.nextCursormeta.hasMore

{
"id": "project_bandori",
"key": "bandori",
"name": "BanG Dream! Girls Band Party!"
}
{
"data": [
{
"id": "project_bandori",
"key": "bandori",
"name": "BanG Dream! Girls Band Party!"
}
],
"meta": {
"limit": 100,
"cursor": "",
"nextCursor": "",
"hasMore": false
}
}