# 简单介绍

  • 本文档主要是针对A3Mall B2B2C标准版程序所编写。
  • 前台H5/微信公众号、微信小程序、APP(Android、IOS)在多终端、跨平台时采用 REST API 进行数据统一请求。

# 公共请求

前台采用get/post/form等方式提交数据

# 数据返回

在客户端每次发送调用API请求,无论成功是否成功,后端都会返回数据,数据格式统一为json。

参数名 类型 描述
code integer 状态
msg string 请求状态说明
data array、json、string 返回请求的数据

后端返回

    return $this->returnAjax("ok",1,[
        // ...
    ]);

返回的数据格式

    {
        "code":1,
        "msg":"",
        "data":[]
    }

# 注意事项

  • 需要注意的是所有的请求和响应数据皆为utf-8格式编码

# 权限说明

在请求api时,权限验证使用中间件拦截或过滤应用的HTTP请求,并进行必要的业务处理。

mall/middleware/VerifyToken.php 权限验证中间件文件

参数 类型 描述
msg string 返回的信息说明
code string 状态码
  • 用户如果未登录返回数据格式
    {
        "msg": "",
        "code": ""
    }    

# 接口调试

在默认状态下,当接口出现异常或错误时可能只返回公共数据json,这时需要打开程序根目录下.env配置文件,直接查看接口返回的错误信息

// 打开应用调式模式
APP_DEBUG = true

// 打开数据库调试模式
[DATABASE]
DEBUG = true

# 接口示例

  • 例:以下是接口完整请求例子
  • 接口描述:注册接口

接下来的api编写中,请求地址将不包含https://a3-mall.com/api/

  • 请求地址:https://a3-mall.com/api/users/login