智简魔方文档

添加接口

方法概览

项目内容
文档类型PHP 类方法
方法标识app\common\model\ServerModel::createServer
所属业务公共接口
来源模块/系统接口模型

功能说明

添加接口

调用示例

$param = ['name' => '示例名称', 'module' => 'string', 'url' => 'https://example.com/callback', 'username' => '示例名称', 'password' => 'Example@123', 'hash' => 'string', 'status' => 0, 'upstream_use' => 0];
$result = (new \app\common\model\ServerModel())->createServer($param);

参数

参数类型必填默认值校验规则说明
param.namestringrequired接口名称
param.modulestringrequired模块类型
param.urlstringrequired地址
param.usernamestring用户名
param.passwordstring密码
param.hashstringhash
param.statusint0是否启用(0=禁用,1=启用)
param.upstream_useint0是否上下游使用

返回值

返回项类型说明
statusint状态码,200成功,400失败
msgstring提示信息
data.idint新建的接口ID

正常返回

{
  "status": 1,
  "msg": "string",
  "data": {
    "id": 1
  }
}

异常情况

异常类型说明
Throwable调用失败时由具体实现抛出异常,异常信息以运行时结果为准。