魔众网盘系统请求和响应

魔众网盘系统 / 文档中心
文档中心
开发教程
安装常见问题

默认情况下,所有接口交互都采用 POST 的请求方式,页面展示采用 GET 的请求方式。

接口统一响应格式

响应使用统一的JSON返回

{
    // 错误码,0表示业务处理正常,非0表示业务处理异常,可以定义多个状态码
    "code": 0,
    // 提示信息
    "msg": "提示信息",
    // 返回数据,根据实际业务使用定义
    "data": {
        //...
    },
    // 跳转地址
    // [js]xxxx : 表示前端执行JS代码
    // [reload] : 表示页面立即刷新 window.location.reload()
    // 其他值    : 表示跳转到改地址
    "redirect": "重定向方式"
}

后端代码可以使用 Response 类统一构造该返回结果

use ModStart\Core\Input\Response;
// 构造完整的返回结果
Response::generate($code, $msg, $data = null, $redirect = null);
// 构造一个成功的结果数据
Response::generateSuccessData([ 'foo'=>'bar' ]);
// 构造一个错误提示
Response::generateError('错误提示');
// 构造一个正确提示
Response::generateSuccess('正确提示');

更多使用方式请参考 Response

默认响应错误码

在基础包 ResponseCodes 中,定义了常用的响应code

// api-token 为空
const API_TOKEN_EMPTY = 1000;
// 需要登录
const LOGIN_REQUIRED = 1001;
// 验证码错误
const CAPTCHA_ERROR = 1002;
// 无权限
const PERMIT_DENIED = 1003;
// 默认错误
const DEFAULT_ERROR = -1;
QQ
微信
公众号