文档

管理后台

账号管理

获取账号列表（分页）

维护人：root

URL

本地开发环境: POST http://localhost:10050/api/admin/accounts/list
开发环境: POST https://tg-live-game.pwtk.cc/api/admin/accounts/list

描述：获取账号列表（分页）

ContentType：application/json

请求参数

Body Parameter

名称	类型	必填	最大长度	描述	示例值
page	Integer	否	-	页码 (从 1 开始)	1
size	Integer	否	-	每页条数	10
keyword	String	否	-	搜索关键词 (模糊匹配名称、ID 等)	摄像头
enabled	Boolean	否	-	启用状态过滤 (null=全部, true=启用, false=禁用)	true
sortBy	String	否	-	排序字段	createdAt
sortDir	String	否	-	排序方向 (ASC/DESC)	DESC

请求示例

{
    "page": 1,
    "size": 10,
    "keyword": "摄像头",
    "enabled": true,
    "sortBy": "createdAt",
    "sortDir": "DESC"
}

响应参数

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "list": [
            {
                "id": 1,
                "username": "admin",
                "nickname": "管理员",
                "enabled": true,
                "lastLoginAt": "2026-01-26T10:00:00",
                "roles": [
                    {
                        "id": 1,
                        "code": "ADMIN",
                        "name": "管理员"
                    }
                ],
                "createdAt": "2026-01-26T10:00:00",
                "updatedAt": "2026-01-26T10:00:00"
            }
        ],
        "page": 1,
        "size": 10,
        "total": 100,
        "totalPages": 10,
        "hasNext": true,
        "hasPrevious": false
    }
}

错误码

无

获取账号详情

维护人：root

URL

本地开发环境: GET http://localhost:10050/api/admin/accounts/detail
开发环境: GET https://tg-live-game.pwtk.cc/api/admin/accounts/detail

描述：获取账号详情

ContentType：application/x-www-form-urlencoded;charset=UTF-8

请求参数

Query Parameter

名称	类型	必填	最大长度	描述	示例值
success	Boolean	否	-	请求是否成功	true
errCode	String	否	-	错误码（失败时返回）
errMessage	String	否	-	错误信息（失败时返回）
data	object	否		响应数据 (ActualType: PageResponse)
└ list	List	否		数据列表 (ActualType: T)
└ id	Long	否	-	主键 ID	1
└ username	String	否	-	用户名	admin
└ nickname	String	否	-	昵称	管理员
└ enabled	Boolean	否	-	是否启用	true
└ lastLoginAt	LocalDateTime	否	-	最后登录时间	2026-01-26T10:00:00
└ roles	List	否		关联的角色列表 (ActualType: RoleSimpleDTO)
└ id	Long	否	-	主键 ID	1
└ code	String	否	-	角色编码	ADMIN
└ name	String	否	-	角色名称	管理员
└ createdAt	LocalDateTime	否	-	创建时间	2026-01-26T10:00:00
└ updatedAt	LocalDateTime	否	-	更新时间	2026-01-26T10:00:00
└ page	Integer	否	-	当前页码 (从 1 开始)	1
└ size	Integer	否	-	每页条数	10
└ total	Long	否	-	总记录数	100
└ totalPages	Integer	否	-	总页数	10
└ hasNext	Boolean	否	-	是否有下一页	true
└ hasPrevious	Boolean	否	-	是否有上一页	false

名称	类型	必填	最大长度	描述	示例值
id	int64	是	-	账号 ID	0

响应参数

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "id": 1,
        "username": "admin",
        "nickname": "管理员",
        "enabled": true,
        "lastLoginAt": "2026-01-26T10:00:00",
        "roles": [
            {
                "id": 1,
                "code": "ADMIN",
                "name": "管理员"
            }
        ],
        "createdAt": "2026-01-26T10:00:00",
        "updatedAt": "2026-01-26T10:00:00"
    }
}

错误码

无

新增账号

维护人：root

URL

本地开发环境: POST http://localhost:10050/api/admin/accounts/add
开发环境: POST https://tg-live-game.pwtk.cc/api/admin/accounts/add

描述：新增账号

ContentType：application/json

请求参数

Body Parameter

名称	类型	必填	最大长度	描述	示例值
success	Boolean	否	-	请求是否成功	true
errCode	String	否	-	错误码（失败时返回）
errMessage	String	否	-	错误信息（失败时返回）
data	object	否		响应数据 (ActualType: AdminDTO)
└ id	Long	否	-	主键 ID	1
└ username	String	否	-	用户名	admin
└ nickname	String	否	-	昵称	管理员
└ enabled	Boolean	否	-	是否启用	true
└ lastLoginAt	LocalDateTime	否	-	最后登录时间	2026-01-26T10:00:00
└ roles	List	否		关联的角色列表 (ActualType: RoleSimpleDTO)
└ id	Long	否	-	主键 ID	1
└ code	String	否	-	角色编码	ADMIN
└ name	String	否	-	角色名称	管理员
└ createdAt	LocalDateTime	否	-	创建时间	2026-01-26T10:00:00
└ updatedAt	LocalDateTime	否	-	更新时间	2026-01-26T10:00:00

请求示例

{
    "username": "operator1",
    "password": "123456",
    "nickname": "操作员小王",
    "roleIds": [
        1,
        2
    ]
}

响应参数

名称	类型	必填	最大长度	描述	示例值
username	String	是	50	用户名 Validate[max: 50; ]	operator1
password	String	是	100	密码 Validate[max: 100; ]	123456
nickname	String	否	50	昵称 Validate[max: 50; ]	操作员小王
roleIds	List	否	-	关联的角色 ID 列表 (ActualType: Long)	[1, 2]

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "id": 1,
        "username": "admin",
        "nickname": "管理员",
        "enabled": true,
        "lastLoginAt": "2026-01-26T10:00:00",
        "roles": [
            {
                "id": 1,
                "code": "ADMIN",
                "name": "管理员"
            }
        ],
        "createdAt": "2026-01-26T10:00:00",
        "updatedAt": "2026-01-26T10:00:00"
    }
}

错误码

无

更新账号

维护人：root

URL

本地开发环境: POST http://localhost:10050/api/admin/accounts/update
开发环境: POST https://tg-live-game.pwtk.cc/api/admin/accounts/update

描述：更新账号

ContentType：application/json

请求参数

Body Parameter

名称	类型	必填	最大长度	描述	示例值
success	Boolean	否	-	请求是否成功	true
errCode	String	否	-	错误码（失败时返回）
errMessage	String	否	-	错误信息（失败时返回）
data	object	否		响应数据 (ActualType: AdminDTO)
└ id	Long	否	-	主键 ID	1
└ username	String	否	-	用户名	admin
└ nickname	String	否	-	昵称	管理员
└ enabled	Boolean	否	-	是否启用	true
└ lastLoginAt	LocalDateTime	否	-	最后登录时间	2026-01-26T10:00:00
└ roles	List	否		关联的角色列表 (ActualType: RoleSimpleDTO)
└ id	Long	否	-	主键 ID	1
└ code	String	否	-	角色编码	ADMIN
└ name	String	否	-	角色名称	管理员
└ createdAt	LocalDateTime	否	-	创建时间	2026-01-26T10:00:00
└ updatedAt	LocalDateTime	否	-	更新时间	2026-01-26T10:00:00

请求示例

{
    "id": 1,
    "nickname": "操作员小王",
    "password": "newPassword123",
    "enabled": true,
    "roleIds": [
        1,
        2
    ]
}

响应参数

名称	类型	必填	最大长度	描述	示例值
id	Long	是	-	管理员 ID	1
nickname	String	否	50	昵称 Validate[max: 50; ]	操作员小王
password	String	否	100	密码（为空则不修改） Validate[max: 100; ]	newPassword123
enabled	Boolean	否	-	是否启用	true
roleIds	List	否	-	关联的角色 ID 列表 (ActualType: Long)	[1, 2]

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "id": 1,
        "username": "admin",
        "nickname": "管理员",
        "enabled": true,
        "lastLoginAt": "2026-01-26T10:00:00",
        "roles": [
            {
                "id": 1,
                "code": "ADMIN",
                "name": "管理员"
            }
        ],
        "createdAt": "2026-01-26T10:00:00",
        "updatedAt": "2026-01-26T10:00:00"
    }
}

错误码

无

删除账号

维护人：root

URL

本地开发环境: POST http://localhost:10050/api/admin/accounts/delete
开发环境: POST https://tg-live-game.pwtk.cc/api/admin/accounts/delete

描述：删除账号

ContentType：application/x-www-form-urlencoded;charset=UTF-8

请求参数

Query Parameter

名称	类型	必填	最大长度	描述	示例值
success	Boolean	否	-	请求是否成功	true
errCode	String	否	-	错误码（失败时返回）
errMessage	String	否	-	错误信息（失败时返回）
data	object	否		响应数据 (ActualType: AdminDTO)
└ id	Long	否	-	主键 ID	1
└ username	String	否	-	用户名	admin
└ nickname	String	否	-	昵称	管理员
└ enabled	Boolean	否	-	是否启用	true
└ lastLoginAt	LocalDateTime	否	-	最后登录时间	2026-01-26T10:00:00
└ roles	List	否		关联的角色列表 (ActualType: RoleSimpleDTO)
└ id	Long	否	-	主键 ID	1
└ code	String	否	-	角色编码	ADMIN
└ name	String	否	-	角色名称	管理员
└ createdAt	LocalDateTime	否	-	创建时间	2026-01-26T10:00:00
└ updatedAt	LocalDateTime	否	-	更新时间	2026-01-26T10:00:00

名称	类型	必填	最大长度	描述	示例值
id	int64	是	-	账号 ID	0

响应参数

名称	类型	必填	最大长度	描述	示例值
success	Boolean	否	-	请求是否成功	true
errCode	String	否	-	错误码（失败时返回）
errMessage	String	否	-	错误信息（失败时返回）
data	object	否	-	响应数据 (ActualType: Void)

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {}
}

错误码

无

批量删除账号

维护人：root

URL

本地开发环境: POST http://localhost:10050/api/admin/accounts/deleteBatch
开发环境: POST https://tg-live-game.pwtk.cc/api/admin/accounts/deleteBatch

描述：批量删除账号

ContentType：application/json

请求参数

Body Parameter

请求示例

{
    "ids": [
        1,
        2,
        3
    ]
}

响应参数

名称	类型	必填	最大长度	描述	示例值
ids	List	是	-	ID 列表 (ActualType: Long)	[1, 2, 3]

名称	类型	必填	最大长度	描述	示例值
success	Boolean	否	-	请求是否成功	true
errCode	String	否	-	错误码（失败时返回）
errMessage	String	否	-	错误信息（失败时返回）
data	int32	否	-	响应数据 (ActualType: Integer)

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": 0
}

错误码

无

角色管理

获取角色列表（分页）

维护人：root

URL

本地开发环境: POST http://localhost:10050/api/admin/roles/list
开发环境: POST https://tg-live-game.pwtk.cc/api/admin/roles/list

描述：获取角色列表（分页）

ContentType：application/json

请求参数

Body Parameter

名称	类型	必填	最大长度	描述	示例值
page	Integer	否	-	页码 (从 1 开始)	1
size	Integer	否	-	每页条数	10
keyword	String	否	-	搜索关键词 (模糊匹配名称、ID 等)	摄像头
enabled	Boolean	否	-	启用状态过滤 (null=全部, true=启用, false=禁用)	true
sortBy	String	否	-	排序字段	createdAt
sortDir	String	否	-	排序方向 (ASC/DESC)	DESC

请求示例

{
    "page": 1,
    "size": 10,
    "keyword": "摄像头",
    "enabled": true,
    "sortBy": "createdAt",
    "sortDir": "DESC"
}

响应参数

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "list": [
            {
                "id": 1,
                "code": "ADMIN",
                "name": "管理员",
                "description": "拥有大部分管理权限",
                "enabled": true,
                "userCount": 5,
                "createdAt": "2026-01-26T10:00:00",
                "updatedAt": "2026-01-26T10:00:00"
            }
        ],
        "page": 1,
        "size": 10,
        "total": 100,
        "totalPages": 10,
        "hasNext": true,
        "hasPrevious": false
    }
}

错误码

无

获取全部启用角色（用于下拉选择）

维护人：root

URL

本地开发环境: GET http://localhost:10050/api/admin/roles/listAll
开发环境: GET https://tg-live-game.pwtk.cc/api/admin/roles/listAll

描述：获取全部启用角色（用于下拉选择）

ContentType：application/x-www-form-urlencoded;charset=UTF-8

请求参数

响应参数

名称	类型	必填	最大长度	描述	示例值
success	Boolean	否	-	请求是否成功	true
errCode	String	否	-	错误码（失败时返回）
errMessage	String	否	-	错误信息（失败时返回）
data	object	否		响应数据 (ActualType: PageResponse)
└ list	List	否		数据列表 (ActualType: T)
└ id	Long	否	-	主键 ID	1
└ code	String	否	-	角色编码	ADMIN
└ name	String	否	-	角色名称	管理员
└ description	String	否	-	角色说明	拥有大部分管理权限
└ enabled	Boolean	否	-	是否启用	true
└ userCount	Integer	否	-	关联用户数量	5
└ createdAt	LocalDateTime	否	-	创建时间	2026-01-26T10:00:00
└ updatedAt	LocalDateTime	否	-	更新时间	2026-01-26T10:00:00
└ page	Integer	否	-	当前页码 (从 1 开始)	1
└ size	Integer	否	-	每页条数	10
└ total	Long	否	-	总记录数	100
└ totalPages	Integer	否	-	总页数	10
└ hasNext	Boolean	否	-	是否有下一页	true
└ hasPrevious	Boolean	否	-	是否有上一页	false

名称	类型	必填	最大长度	描述	示例值
success	Boolean	否	-	请求是否成功	true
errCode	String	否	-	错误码（失败时返回）
errMessage	String	否	-	错误信息（失败时返回）
data	array	否		响应数据 (ActualType: List)
└ id	Long	否	-	主键 ID	1
└ code	String	否	-	角色编码	ADMIN
└ name	String	否	-	角色名称	管理员

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": [
        {
            "id": 1,
            "code": "ADMIN",
            "name": "管理员"
        }
    ]
}

错误码

无

获取角色详情

维护人：root

URL

本地开发环境: GET http://localhost:10050/api/admin/roles/detail
开发环境: GET https://tg-live-game.pwtk.cc/api/admin/roles/detail

描述：获取角色详情

ContentType：application/x-www-form-urlencoded;charset=UTF-8

请求参数

Query Parameter

名称	类型	必填	最大长度	描述	示例值
id	int64	是	-	角色 ID	0

响应参数

名称	类型	必填	最大长度	描述	示例值
success	Boolean	否	-	请求是否成功	true
errCode	String	否	-	错误码（失败时返回）
errMessage	String	否	-	错误信息（失败时返回）
data	object	否		响应数据 (ActualType: RoleDTO)
└ id	Long	否	-	主键 ID	1
└ code	String	否	-	角色编码	ADMIN
└ name	String	否	-	角色名称	管理员
└ description	String	否	-	角色说明	拥有大部分管理权限
└ enabled	Boolean	否	-	是否启用	true
└ userCount	Integer	否	-	关联用户数量	5
└ createdAt	LocalDateTime	否	-	创建时间	2026-01-26T10:00:00
└ updatedAt	LocalDateTime	否	-	更新时间	2026-01-26T10:00:00

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "id": 1,
        "code": "ADMIN",
        "name": "管理员",
        "description": "拥有大部分管理权限",
        "enabled": true,
        "userCount": 5,
        "createdAt": "2026-01-26T10:00:00",
        "updatedAt": "2026-01-26T10:00:00"
    }
}

错误码

无

新增角色

维护人：root

URL

本地开发环境: POST http://localhost:10050/api/admin/roles/add
开发环境: POST https://tg-live-game.pwtk.cc/api/admin/roles/add

描述：新增角色

ContentType：application/json

请求参数

Body Parameter

名称	类型	必填	最大长度	描述	示例值
code	String	是	50	角色编码（唯一标识，只允许大写字母、数字和下划线） Validate[max: 50; regexp: ^[A-Z][A-Z0-9_]*$; ]	OPERATOR
name	String	是	100	角色名称 Validate[max: 100; ]	操作员
description	String	否	500	角色说明 Validate[max: 500; ]	拥有日常操作权限

请求示例

{
    "code": "OPERATOR",
    "name": "操作员",
    "description": "拥有日常操作权限"
}

响应参数

名称	类型	必填	最大长度	描述	示例值
success	Boolean	否	-	请求是否成功	true
errCode	String	否	-	错误码（失败时返回）
errMessage	String	否	-	错误信息（失败时返回）
data	object	否		响应数据 (ActualType: RoleDTO)
└ id	Long	否	-	主键 ID	1
└ code	String	否	-	角色编码	ADMIN
└ name	String	否	-	角色名称	管理员
└ description	String	否	-	角色说明	拥有大部分管理权限
└ enabled	Boolean	否	-	是否启用	true
└ userCount	Integer	否	-	关联用户数量	5
└ createdAt	LocalDateTime	否	-	创建时间	2026-01-26T10:00:00
└ updatedAt	LocalDateTime	否	-	更新时间	2026-01-26T10:00:00

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "id": 1,
        "code": "ADMIN",
        "name": "管理员",
        "description": "拥有大部分管理权限",
        "enabled": true,
        "userCount": 5,
        "createdAt": "2026-01-26T10:00:00",
        "updatedAt": "2026-01-26T10:00:00"
    }
}

错误码

无

更新角色

维护人：root

URL

本地开发环境: POST http://localhost:10050/api/admin/roles/update
开发环境: POST https://tg-live-game.pwtk.cc/api/admin/roles/update

描述：更新角色

ContentType：application/json

请求参数

Body Parameter

名称	类型	必填	最大长度	描述	示例值
id	Long	是	-	角色 ID	1
code	String	是	50	角色编码 Validate[max: 50; regexp: ^[A-Z][A-Z0-9_]*$; ]	OPERATOR
name	String	是	100	角色名称 Validate[max: 100; ]	操作员
description	String	否	500	角色说明 Validate[max: 500; ]	拥有日常操作权限
enabled	Boolean	否	-	是否启用	true

请求示例

{
    "id": 1,
    "code": "OPERATOR",
    "name": "操作员",
    "description": "拥有日常操作权限",
    "enabled": true
}

响应参数

名称	类型	必填	最大长度	描述	示例值
success	Boolean	否	-	请求是否成功	true
errCode	String	否	-	错误码（失败时返回）
errMessage	String	否	-	错误信息（失败时返回）
data	object	否		响应数据 (ActualType: RoleDTO)
└ id	Long	否	-	主键 ID	1
└ code	String	否	-	角色编码	ADMIN
└ name	String	否	-	角色名称	管理员
└ description	String	否	-	角色说明	拥有大部分管理权限
└ enabled	Boolean	否	-	是否启用	true
└ userCount	Integer	否	-	关联用户数量	5
└ createdAt	LocalDateTime	否	-	创建时间	2026-01-26T10:00:00
└ updatedAt	LocalDateTime	否	-	更新时间	2026-01-26T10:00:00

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "id": 1,
        "code": "ADMIN",
        "name": "管理员",
        "description": "拥有大部分管理权限",
        "enabled": true,
        "userCount": 5,
        "createdAt": "2026-01-26T10:00:00",
        "updatedAt": "2026-01-26T10:00:00"
    }
}

错误码

无

删除角色

维护人：root

URL

本地开发环境: POST http://localhost:10050/api/admin/roles/delete
开发环境: POST https://tg-live-game.pwtk.cc/api/admin/roles/delete

描述：删除角色

ContentType：application/x-www-form-urlencoded;charset=UTF-8

请求参数

Query Parameter

名称	类型	必填	最大长度	描述	示例值
id	int64	是	-	角色 ID	0

响应参数

名称	类型	必填	最大长度	描述	示例值
success	Boolean	否	-	请求是否成功	true
errCode	String	否	-	错误码（失败时返回）
errMessage	String	否	-	错误信息（失败时返回）
data	object	否	-	响应数据 (ActualType: Void)

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {}
}

错误码

无

批量删除角色

维护人：root

URL

本地开发环境: POST http://localhost:10050/api/admin/roles/deleteBatch
开发环境: POST https://tg-live-game.pwtk.cc/api/admin/roles/deleteBatch

描述：批量删除角色

ContentType：application/json

请求参数

Body Parameter

请求示例

{
    "ids": [
        1,
        2,
        3
    ]
}

响应参数

名称	类型	必填	最大长度	描述	示例值
ids	List	是	-	ID 列表 (ActualType: Long)	[1, 2, 3]

名称	类型	必填	最大长度	描述	示例值
success	Boolean	否	-	请求是否成功	true
errCode	String	否	-	错误码（失败时返回）
errMessage	String	否	-	错误信息（失败时返回）
data	int32	否	-	响应数据 (ActualType: Integer)

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": 0
}

错误码

无

user-and-role.md 31 KB Historia Raaka

文档

管理后台

账号管理

获取账号列表（分页）

URL

请求参数

Body Parameter

请求示例

响应参数

响应示例

错误码

获取账号详情

URL

请求参数

Query Parameter

响应参数

响应示例

错误码

新增账号

URL

请求参数

Body Parameter

请求示例

响应参数

响应示例

错误码

更新账号

URL

请求参数

Body Parameter

请求示例

响应参数

响应示例

错误码

删除账号

URL

请求参数

Query Parameter

响应参数

响应示例

错误码

批量删除账号

URL

请求参数

Body Parameter

请求示例

响应参数

响应示例

错误码

角色管理

获取角色列表（分页）

URL

请求参数

Body Parameter

请求示例

响应参数

响应示例

错误码

获取全部启用角色（用于下拉选择）

URL

请求参数

响应参数

响应示例

错误码

获取角色详情

URL

请求参数

Query Parameter

响应参数

响应示例

错误码

新增角色

URL

请求参数

Body Parameter

请求示例

响应参数

响应示例

错误码

user-and-role.md 31 KB

Historia Raaka