删除邀请码
1. 接口定位
- 接口名称: 删除邀请码
- 所属域: admin/invitation-code
- 业务目标: 批量删除指定邀请码记录
2. 请求定义
- Method:
POST - Path:
/invitation_code/del - Content-Type: 推荐
application/json - operationID: 必填,请通过 Header
operationID传入 - 鉴权: 需要 Header
token,且必须是管理员 token - 幂等性: 非幂等;若目标邀请码不存在会直接返回失败
3. 请求参数
Header 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| operationID | 是 | string | 链路追踪 ID |
| token | 是 | string | 管理员 token |
Body 参数
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
| codes | 是 | array<string> | 要删除的邀请码列表 |
字段约束
- 协议校验要求
codes不能为null。 - RPC 层要求
codes长度必须大于0。 codes中不允许出现重复值。- 删除前会先查询数据库,要求请求中的每一个邀请码都必须存在;只要缺一个就整体失败。
4. 响应结构
通用响应包裹
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情 |
| data | object | 业务数据 |
data 字段
- 本接口成功时返回空对象(无业务字段)。
5. 业务规则
- 仅管理员可以调用。
- 服务端先按
codes全量查询。 - 如果数据库中命中的数量与请求数量不一致,会计算缺失项并返回
code not found ...。 - 只有当全部邀请码都存在时,才会执行批量删除。
6. 错误码与失败场景
| 错误码 | 场景 | 典型报错 |
|---|---|---|
| 1001 | codes 为 null | codes is empty |
| 1001 | codes 为空数组 | codes is empty |
| 1001 | codes 内存在重复值 | codes is duplicate |
| 1001 | 部分邀请码不存在 | code not found xxx, yyy |
| - | 数据库删除失败 | 由数据库层返回原始错误 |
7. 示例
fetch 请求示例
javascript
fetch("http://localhost:10009/invitation_code/del", {
method: "POST",
headers: {
operationID: "550e8400-e29b-41d4-a716-446655440403",
token: "eyJhbGciOi...",
"Content-Type": "application/json",
},
body: JSON.stringify({
codes: ["WELCOME2026", "BETA-USER-001"],
}),
})
.then((res) => res.json())
.then((data) => console.log(data));请求示例(JSON)
json
{
"codes": ["WELCOME2026", "BETA-USER-001"]
}成功响应示例
json
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {}
}失败响应示例
json
{
"errCode": 1001,
"errMsg": "ArgsError",
"errDlt": "code not found MISSING-CODE"
}8. 时序流程
- 中间件校验管理员 token。
- 校验
codes是否为空、是否含重复项。 - 按请求列表查询邀请码记录。
- 若存在缺失邀请码,则直接返回失败。
- 执行批量删除并返回成功响应。
9. 变更记录
- 2026-03-31: 首版发布,基于邀请码删除前的全量存在性校验逻辑补全文档。