moponphp / apidoc
mopon泰久php项目组 通过注释获取对外文档
1.0.6
2017-03-10 03:58 UTC
Requires
- php: >=5.4.0
This package is not auto-updated.
Last update: 2020-08-02 17:07:24 UTC
README
- 主要实现动态文档的功能
- 使用方法: 载入这个模块,访问这个控制器,参照gii实现方式
- 预留复写函数:
- filter* 过滤函数
- proxy 代理函数 用于代理访问接口,一般这个方法会被重载,因为接口往往有加密算法
protected function proxy($route){ ////$params = return parent::proxy($route,$params); }
fixData 修复数据,参考filter方法,就是对返回的数据进行修正的
- 预留的兼容配置文件: @app/config/setting.php 之前都是走配置文件的,之前的配合文件写好不容易,不能就这么扔掉啊
- 对外的方法:
- index 显示页面
- settting 设置配置文件(静态化文档)
- 添加注释方法:控制器注释:文件的第二行,action方法注释
title: 多行注释的第一行 or 单行注释的内容 params: 添加注释 * @param string $name 姓名 * @param radio $type=1 类型 {1:'张三',2:'李四'} 添加 参数验证规则数组(这个验证函数必须是第一个有效表达式) $arrVerifyParamsRule=[ 'id'=>['订单id',false,'int'], 'goods_code'=>['商品编码',false,'string'], 'goods_product_title'=>['商品名称',false,'string'], 'mobile'=>['手机',false,'int'], 'username'=>['用户名',false,'string'], ]; 方法参数(函数括号内生命的变量,必须在前两种失效的情况下才起作用) public function actionLogin($user_id){}
如需测试加密,可以继承这个方法之后重写 _proxy方法,对访问参数进行修正
- 用法:配置文件中添加如下代码 $config['bootstrap'][] = 'apidoc'; $config['modules']['apidoc'] = [
'class' => 'moponphp\apidoc\Module',
];
- 如需扩展控制器集成这个类,重写类中的方法