跳转到内容

CharacterGroup(角色与组合关系)

CharacterGroup 连接一个 Character 与一个 Group。

关系属性描述 CharacterGroup 这条连接本身。本轮只记录稳定的端点 key。

FieldTypesupportedDescription
idstring✓由 key 生成的稳定公开 ID;客户端应视为 opaque。
keystring✓全局唯一稳定 key,用于过滤和跨域引用。
characterKeystring✓被关联的 Character key。
groupKeystring✓被关联的 Group key。
displayNamestring✓Character 在该 Group 下的展示名;空字符串表示使用 Character 本名。
displayOrdernumber✓在同一 Group 下的角色展示顺序;数值越小越靠前。未配置时返回 0。

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

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

MethodPathDescription
GET/api/v1/character-groups列出 Character 与 Group 关系。
GET/api/v1/character-groups/{key}通过 key 获取单条 Character 与 Group 关系。

列表路由支持 cursor 分页:

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

列表响应包含 meta.limit、meta.cursor、meta.nextCursor 和 meta.hasMore。

{
"id": "character_group_takamatsu_tomori_mygo",
"key": "takamatsu_tomori_mygo",
"characterKey": "takamatsu_tomori",
"groupKey": "mygo",
"displayName": "",
"displayOrder": 0
}
{
"data": [
{
"id": "character_group_takamatsu_tomori_mygo",
"key": "takamatsu_tomori_mygo",
"characterKey": "takamatsu_tomori",
"groupKey": "mygo",
"displayName": "",
"displayOrder": 0
}
],
"meta": {
"limit": 100,
"cursor": "",
"nextCursor": "",
"hasMore": false
}
}