API

这里的API指整个API接口模块，这里仅做部分API功能模块的使用介绍，如果需要查看前端开发和后端开发文档，请查看相对应的文档

流程介绍

FastAdmin的API模块完全遵循ThinkPHP5的开发规范，在此基础上我们在API模块中提供了一个和前台相同的权限验证模块，我们可以方便快捷的控制我们的可访问权限。

FastAdmin的API模块采用默认的路由方式进行匹配，当然我们完全可以自定义我们的路由规则，达到个性化URL接口的目的

基类解析

API的所有功能模块的控制器都是继承于application/common/controller/Api.php这个基类控制器

在基类控制器中我们有定义一些基础属性和通用方法，首先们我看看基础属性

  1. /**
  2.  * @var array 前置操作方法列表
  3.  */
  4. protected $beforeActionList = [];
  6. /**
  7.  * 无需登录的方法,同时也就不需要鉴权了
  8.  * @var array
  9.  */
  10. protected $noNeedLogin = [];
  12. /**
  13.  * 无需鉴权的方法,但需要登录
  14.  * @var array
  15.  */
  16. protected $noNeedRight = [];
  18. /**
  19.  * 权限Auth
  20.  * @var Auth 
  21.  */
  22. protected $auth = null;

其次我们来看下基类的方法

  3. /**
  4.  * 加载语言文件
  5.  * @param string $name
  6.  */
  7. protected function loadlang($name)
  8. {
  9. }
  11. /**
  12.  * 操作成功返回的数据
  13.  * @param string $msg   提示信息
  14.  * @param mixed $data   要返回的数据
  15.  * @param int   $code   错误码，默认为1
  16.  * @param string $type  输出类型
  17.  * @param array $header 发送的 Header 信息
  18.  */
  19. protected function success($msg = '', $data = null, $code = 1, $type = null, array $header = [])
  20. {
  21. }
  23. /**
  24.  * 操作失败返回的数据
  25.  * @param string $msg   提示信息
  26.  * @param mixed $data   要返回的数据
  27.  * @param int   $code   错误码，默认为0
  28.  * @param string $type  输出类型
  29.  * @param array $header 发送的 Header 信息
  30.  */
  31. protected function error($msg = '', $data = null, $code = 0, $type = null, array $header = [])
  32. {
  33. }
  35. /**
  36.  * 返回封装后的 API 数据到客户端
  37.  * @access protected
  38.  * @param mixed  $msg    提示信息
  39.  * @param mixed  $data   要返回的数据
  40.  * @param int    $code   错误码，默认为0
  41.  * @param string $type   输出类型，支持json/xml/jsonp
  42.  * @param array  $header 发送的 Header 信息
  43.  * @return void
  44.  * @throws HttpResponseException
  45.  */
  46. protected function result($msg, $data = null, $code = 0, $type = null, array $header = [])
  47. {
  48. }
  50. /**
  51.  * 前置操作
  52.  * @access protected
  53.  * @param  string $method  前置操作方法名
  54.  * @param  array  $options 调用参数 ['only'=>[...]] 或者 ['except'=>[...]]
  55.  * @return void
  56.  */
  57. protected function beforeAction($method, $options = [])
  58. {
  59. }
  61. /**
  62.  * 验证数据
  63.  * @access protected
  64.  * @param  array        $data     数据
  65.  * @param  string|array $validate 验证器名或者验证规则数组
  66.  * @param  array        $message  提示信息
  67.  * @param  bool         $batch    是否批量验证
  68.  * @param  mixed        $callback 回调方法（闭包）
  69.  * @return array|string|true
  70.  * @throws ValidateException
  71.  */
  72. protected function validate($data, $validate, $message = [], $batch = false, $callback = null)
  73. {
  74. }

以上的属性和方法我们都可以通过在当前控制器定义来达到覆盖的目的。

功能模块

会员模块

我们在FastAdmin的API中集成了简单的会员接口，可以进行会员的注册、登录、找回密码、会员中心、修改个人资料、修改密码等操作。

会员模块可用于进行API会员功能开发时使用。此处的会员模块和前台中的会员模块账号是相通的，但他们登录时是不会互相影响的，可以同时登录。

FastAdmin的会员模块有注册几个事件，我们可以在事件中自定义我们的操作。你可以按照以下的方式监听相应的事件行为

  1. //登录成功后的事件
  2. Hook::add('user_login_successed', function ($user) {
  3. });
  4. //注册成功后的事件
  5. Hook::add('user_register_successed', function ($user) {
  6. });
  7. //会员删除后的事件
  8. Hook::add('user_delete_successed', function ($user) {
  9. });
  10. //会员注销后的事件
  11. Hook::add('user_logout_successed', function ($user) {
  12. });

短信模块

我们在FastAdmin的API中集成了简单的短信模块，可以根据相对应的事件进行短信的发送和检测是否正确等功能。

在使用短信模块时请确保已经正确在后台正确安装并启用了第三方短信插件。

公共模块

公共模块一般用于客户端应用初始化时调用，例如APP的版本检测、APP的首屏轮换图等功能。

检测模块

检测模块一般用于检测客户端提交数据的有效性验证，也常用于在前台进行数据录入时的实时有效性校验。