应用接口
文章分页:

myApi.class.php 用于注册和运行指定方法,该方法可根据给出的参数返回一个数组,再由本类转换为对应的格式,本类包含三个方法:

  • regMethod($method, $func):用于将指定的方法 $func,注册为名为 $method 的接口;
  • regMethods($method_list):批量注册一组方法,$method_list 为一个字符串下标的数组,下标为接口名称,值为对应方法;
  • run($method, $para, $return, $charset):执行名为 $method 的方法,并向其传递 $para 参数,返回值格式 $return 默认为 json,返回值的字符集 $charse 默认为 utf-8。其中返回值可以为如下格式:
    • x 或 xml - XML 格式;
    • s 或 string - 序列化的字符串;
    • h 或 hex - 转换为16进制格式的序列化字符串;
    • c、code 或 script - php 数组脚本;
    • j 或 json - JSON 格式的字符串

框架接口可在应用目录的 route.php 中定义,具体格式参见路由模块,接口的调用方法为:/api/[str]/[any] ,其中 [str]为app名称,[any]为接口名及参数,可通过_GET_POST模式接收参数,可通过在url最后加上"/返回类型"来控制数据格式(可选,默认为json,其他格式见上)。如需在某一APP内(如绑定域名的app)调用另外一个APP的插件接口(如captcha),可通过在url后上加上"&core=[AppName]",以保证接口依照对应app的设置执行。

框架默认提供了附件上传、下载、删除的 API 接口:

  • /api/myStep/upload - 文件上传接口,上传文件保存在常量FILE目录
  • /api/myStep/download/[any] - 文件下载接口,[any]为文件索引
  • /api/myStep/remove/[any] - 上传文件删除接口,[any]为文件索引

框架后台含附件文件管理模块,所有应用均可以利用此接口管理附件,同时为保证文件安全,在执行 upload 和 remove 操作时会判断是否存在名为 sysop 的 session,所以需要在应用登陆管理员账户时需要增加对应设置,以保证相关功能的正常执行(核心框架的login方法已包含)。同时,APP 也可以通过自定义接口来实现诸如给图片附件加水印之类的操作。

 

上一篇:路由模块
下一篇:页面模版