[第十章]多接口操作使用教程

该功能适用于多操作的接口场景，无该功能需求无需配置

一、什么是多操作接口？

多操作接口，就是一个接口地址对应多个不同的业务功能

例如卡密接口：

生成卡密：
/api/card/?apikey=你开通的apikey&q=10&time=30

验证卡密：
/api/card/?apikey=你开通的apikey&key=卡密

这两个请求地址都是 /api/card/，但参数不同：

• q、time 用于生成卡密
• key 用于验证卡密

这种情况就适合使用“操作管理”。

如果一个接口只有一种调用方式，就不需要配置操作管理。

---

二、配置前先规划好操作

以卡密接口为例，可以规划成两个操作：

操作名称	用途	必填业务参数
生成卡密	批量生成卡密	q、time
验证卡密	验证卡密是否有效	key

两个操作的必填参数必须有明显区别，否则系统无法准确判断用户请求的是哪一个操作。

---

三、已有接口添加操作

第一步：进入接口列表

登录后台后，进入：

接口管理 → 接口列表

找到需要增加操作的接口，点击“编辑”。

第二步：打开操作管理

在接口编辑窗口顶部切换到：

操作管理

点击“新增操作”。

---

四、填写操作信息

新增操作窗口分为两个标签：

接口信息
参数内容

1. 接口信息

字段	填写说明
操作名称	填写简短明确的名称，例如“生成卡密”
请求方式	根据接口实际情况选择 GET 或 POST
返回格式	根据实际返回内容选择 json、text、img 等
权重	一般保持默认值即可
启用状态	开启后才会显示该操作

例如“生成卡密”操作可以这样填写：

操作名称：生成卡密
请求方式：GET
返回格式：json
权重：默认
启用状态：启用

操作名称不要重复，也不要写得过长，建议直接使用“生成卡密”“验证卡密”“查询余额”这类名称。

---

五、填写请求参数

切换到“参数内容”，找到“请求参数”。

1. 生成卡密操作参数

“生成卡密”操作可以添加：

参数名称	是否必填	参数类型	参数说明或示例值
apikey	是	字符串	你开通的apikey
q	是	数字	生成数量，例如：10
time	是	数字	有效时间，例如：30

最终请求地址：

/api/card/?apikey=你开通的apikey&q=10&time=30

其中：

APIKEY：替换成真实接口密钥
q=10：生成 10 个卡密
time=30：有效时间为 30

2. 验证卡密操作参数

“验证卡密”操作可以添加：

参数名称	是否必填	参数类型	参数说明或示例值
apikey	是	字符串	接口密钥
key	是	字符串	要验证的卡密

最终请求地址：

/api/card/?apikey=你开通的apikey&key=卡密

两个操作都可以有 apikey，这是正常的。真正区分它们的是：

生成卡密：q、time
验证卡密：key

---

六、填写返回参数

在“参数内容”中找到“返回参数”，按照接口实际返回的数据填写。

例如接口返回：

{
  "code": 200,
  "msg": "生成成功",
  "data": {
    "cards": [
      "ABC123456",
      "DEF789012"
    ]
  }
}

可以填写：

参数名称	参数类型	参数说明
code	数字	返回状态码
msg	字符串	返回提示信息
data	对象	业务数据
cards	数组	生成的卡密列表

验证卡密返回内容如果不同，就在“验证卡密”操作中单独填写对应的返回参数。

每个操作的返回参数可以完全不同，不需要和主接口保持一致。

---

七、填写状态码说明

每个操作都可以单独设置状态码说明。

例如“生成卡密”：

状态码	参数说明
200	生成成功
400	请求参数错误
401	接口密钥无效
403	当前用户无权使用该接口
500	服务处理失败

例如“验证卡密”：

状态码	参数说明
200	卡密有效
400	卡密参数不能为空
401	接口密钥无效
404	卡密不存在
410	卡密已过期

状态码要根据接口真实返回结果填写，不要只填写一个 200。

---

八、填写返回示例

在“参数内容”中找到“返回示例”，填写完整的 JSON 或文本返回结果。

生成成功示例

{
  "code": 200,
  "msg": "生成成功",
  "data": {
    "cards": [
      "ABC123456",
      "DEF789012"
    ]
  }
}

验证成功示例

{
  "code": 200,
  "msg": "卡密有效",
  "data": {
    "status": 1,
    "expire_time": "2026-12-31 23:59:59"
  }
}

返回示例要和实际接口返回格式一致，这样用户查看接口文档时才能正确理解返回内容。

---

九、保存操作

填写完成后：

1. 点击操作窗口中的保存按钮
2. 确认操作出现在操作列表中
3. 检查操作名称、请求方式和启用状态
4. 最后保存整个接口配置

添加新接口时，也是同样的流程：

添加接口 → 填写接口基本信息 → 操作管理 → 新增操作 → 保存操作 → 保存接口

不要只保存操作窗口而忘记保存整个接口。

---

十、如何测试操作

测试生成卡密

http://你的域名/api/card/?apikey=真实密钥&q=10&time=30

测试验证卡密

http://你的域名/api/card/?apikey=你开通的apikey&key=ABC123456

测试时注意：

• 参数名称必须完全一致
• 参数大小写不要随意修改
• GET 请求放在 URL 参数中
• POST 请求放在请求体中
• 使用接口域名时，域名地址要替换成已启用的接口域名

---

十一、常见问题

1. 接口地址要不要分别填写？

不需要。

多个操作共用主接口地址，例如：

/api/card/

不要把下面这些内容直接写入接口地址：

?q=10&time=30

这些应该配置在对应操作的“请求参数”中。

6. 只有一个功能，还需要添加操作吗？

不需要。

如果接口只有一种请求方式，直接按照普通接口配置即可，避免增加不必要的操作。

---