ThinkAdmin 数据接口说明

ThinkAdmin学习总结
学习总结
ThinkAdmin源码 https://gitee.com/zoujingli/ThinkAdmin

ThinkAdmin基于ThinkPHP6中的一些核心组件:

think-helper(助手函数)
think-multi-app(实现多应用模式)
think-orm(提供对象化数据查询)
think-template(基于XML和标签库的编译型模板引擎)
think-view(模板引擎驱动)
ThinkPHP6中对一些功能模块进行了组件化,架构风格也与Laravel很相似了, 如果接触过Laravel组件式开发的小伙伴, 对于这种比较简单的二开框架上手应该很快。
对于一般的增删改查, 完全可以按使用TP6的编码习惯进行开发。当然也可以使用二开作者封装的方法

二次封装的常用方法
Controller:

$this->_vali() 常规验证 对数据进行常规校验, 如unique require max min between
$this->_form() 快捷表单逻辑器
$this->error() 请求失败Response
$this->success() 请求成功Response
数据库表
system_auth 角色表
system_auth_node 角色-权限(节点)表
system_config 系统配置参数
system_data 系统-数据
system_menu 系统菜单
system_oplog 登录日志
system_queue 系统任务
system_user 后台系统用户
wechat_fans 公众号-粉丝
wechat_fans_tags 微信-标签
wechat_keys 微信-关键字(关注回复规则)
wechat_media 微信-素材
wechat_news 微信-图文
wechat_news_article 微信-文章

数据接口说明

一、数据请求与响应标准

目前平台只支持标准 form 表单方式提交数据,数据类型需要设置为:x-www-form-urlencoded。

如果需要上传文件,可以使用 base64 方式上传,服务端再转存为文件,若要上传大文件建议直接对接云存储。

服务端接口响应 json 内容,内容固定三个字段 code、info、data,其中 code 为状态码,info 为消息内容,data 为返回数据内容。

{
  "code": 0,
  "info": "接口返回提示消息",
  "data": {}
}

终端 javascript 请求示例

var xhr = new XMLHttpRequest();
xhr.open('post', 'https://v6.thinkadmin.top/data/api.data/getSlider', true);

xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
xhr.send("username=USER&password=12356");

xhr.onload = function () {
  if (xhr.status === 200) {
    var text = xhr.responseText;
    var response = JSON.parse(text);
    console.log(response)
  } else {
    console.log(xhr)
  }
};

二、认证授权机制 = 授权通道 + 授权令牌(api+token)

目前平台支持三种登录方式(微信小程序,微信服务号,WAP网站),三种登录方式在登录之后都会返回 token 和 有效时间。在获取到 token 值后,需认证的接口都需要传 token 值 和 api 授权通道。每个 api 授权通道同一时间内只能产生一个 token,也就是说一种终端只能登录一次。每个 token 对终端的 user-agent 信息绑定,更改后视为终端已经更换,token 则无效,需要重新使用新终端登录。

授权 token 值可以使用 get、post、header 三种方式提交,从安全角度来说,建议使用 header 方式提交。

授权 api 值可以使用 get、post 两种方式提交(微信小程序对应值为 wxapp,微信服务号对应值为 wechat,WAP 网站对应值为 wap)

默认接口状态码

当接口状态码 code 返回 401 时,表示需要重新登录,错误信息见 info 字段,数据见 data 字段。

当接口状态码 code 返回 0 时,表示服务端业务执行失败,错误信息见 info 字段,数据见 data 字段。

当接口状态码 code 返回 1 时,表示服务端业务执行成功,提示信息见 info 字段,数据见 data 字段。

其他接口状态码 code 值可以根据实际情况定义,需要与接口客户端一起协商。

三、更多案例文档

ThinkiAdmin 案例文档

ThinkAdmin 数据接口说明
滚动到顶部