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