文章详情
该功能为V1.5版本新增，文档先出 程序后面更新 ，请等待新版本更新使用，以下为配置教程
API管理系统操作手册
一、概述
二、添加/编辑API
2.1 接口信息
基础信息
| 字段 | 说明 |
|---|---|
| 选择分类 | 选择API所属的分类（需先添加分类） |
| API名称 | 接口的名称，如“IP查询” |
| API关键词 | 用于搜索的关键词，多个用英文逗号隔开 |
| API简介 | 简要描述接口功能 |
| 接口地址 | 完整的调用地址（例如：https://api.example.com/endpoint） |
| 接口目录名 | 用于生成调用URL的标识，例如 ip，调用时可通过 apis.php?api=ip 访问 |
| 返回格式 | 接口返回的数据格式：json、text、img、audio/mp3、video/mp4 |
| 请求方式 | 客户端调用该接口时使用的HTTP方法（GET/POST/PUT/DELETE/PATCH） |
| 成功返回示例 | 填写一个成功的返回示例，便于测试和文档生成 |
| 接口权重 | 数字越大，在列表中的排名越靠前 |
| 接口实名可用 | 无需实名 / 需要实名（控制是否要求用户实名认证） |
| 公告开关 | 开启后可在下方填写公告内容，用户调用时会显示 |
| 公告内容 | 公告文本，支持HTML |
转发配置
当需要将当前接口的请求转发到第三方接口时，配置此部分。所有转发配置项会统一保存在数据库的 forward_configJSON字段中。
| 字段 | 说明 |
|---|---|
| 接口地址 | 第三方目标接口的完整URL |
| 请求方式 | 转发给第三方接口时使用的HTTP方法（GET/POST） |
| 秘钥值 | 对方接口需要的秘钥/令牌（如 api_secret） |
| 秘钥参数名 | 发送秘钥时使用的参数名，例如 apikey、token |
| 传递位置 | 秘钥的放置位置：请求头 (Header) 或 请求参数 (Query) |
| 成功类型 | 判断本次转发是否成功的规则类型（详见下文） |
| 判断规则 | 与成功类型配合使用的规则内容 |
2.2 成功判断类型详解
| 类型 | 说明 | 规则格式 | 示例 |
|---|---|---|---|
| JSON字段匹配 | 当返回为JSON时，检查指定字段的值是否等于期望值 | 字段路径=期望值 |
code=0data.status=success |
| JSON路径匹配 | 使用JSONPath表达式定位值并比较 | $.路径=期望值 |
$.data[0].id=100 |
| 文本包含关键词 | 返回为纯文本时，判断是否包含指定关键词 | 关键词 |
success操作成功 |
| 文本正则匹配 | 使用正则表达式匹配返回文本 | 正则表达式 |
/成功//^OK$/ |
| HTTP状态码等于 | 检查HTTP状态码是否等于指定值 | 状态码 |
200404 |
| HTTP状态码范围 | 检查状态码是否在指定范围内 | 起始-结束 |
200-299400-499 |
| 响应头包含 | 检查响应头中是否存在指定键值对 | 头字段=值 |
Content-Type=application/jsonX-Status=success |
$.store.book[0].title），如需复杂表达式可等待后续扩展。/），系统会自动添加 # 作为定界符。2.3 参数内容
请求参数说明
apikey，必填，类型string，说明“你开通的apikey”，可删除。返回参数说明
data.user.id）2.4 计费模式
| 选项 | 说明 |
|---|---|
| 按量计费 | 每次调用扣除固定点数（在“接口价格”中设置） |
| 包月计费 | 提供套餐，用户购买后可在有效期内无限次调用 |
| 会员组 | 仅限指定会员组免费使用 |
金额-天数，一行一个，例如：9.9-30 表示30天9.9元。三、常见问题
3.1 为什么我的转发请求返回了301？
3.2 如何调试转发是否成功？
$response 和 $http_code。也可以使用浏览器开发者工具观察网络请求。3.3 成功判断规则未生效？
微信扫一扫 
支付宝扫一扫 版权：
转载请注明出处：https://www.52hyjs.com/97.html
相关推荐
还没有评论呢，快来抢沙发~