README

ThinkPHP5 文档生成工具(本地加载CSS和JS)

访问地址:配置的域名/doc?user=user&label=label
    user：用户
    label：用户标识
    user、label 必传且不能为空,且在 doc.php 里的 auth数组中存在,否则无法访问

使用说明

1.安装 composer require phpdaxin/apidoc
  更新 composer update phpdaxin/apidoc
  删除 composer remove phpdaxin/apidoc

2.安装完成：
    ThinkPHP5.0 在 application/extra 目录下创建名为 doc.php 的文件;
    ThinkPHP5.1 在 config 目录下创建名为 doc.php 的文件;
    配置文件内容如下：
    ```
    <?php
    return [
        'title' => "接口文档",
        'url' => 'http://www.xxxx.com',    // 请求链接
        'desc' => '1.注意事项;2.项目说明',  // 注意事项 或 项目说明
        'header'=>[     // 通用 请求头参数
            // 不用通用接收参数 如：文件地址：app/index/controller/index 方法名称：index(),demo() ...等等
            // 1.整个class：app/index/controller/index(文件地址)
            // 2.单个函数：app/index/controller/index/demo(文件地址/方法名称)
            'hidden' => ['app/index/controller/index'],
            'data' => [
                [
                    'name' => 'id',
                    'type' => 'string',
                    'required' => true,
                    'default' => '',
                    'desc' => '加密参数 字符串且不能为空',
                ]
            ]
        
        ]
        'param' => [    // 通用 接收参数
            // 不用通用接收参数 如：文件地址：app/index/controller/index 方法名称：index(),demo() ...等等
            // 1.整个class：app/index/controller/index(文件地址)
            // 2.单个函数：app/index/controller/index/demo(文件地址/方法名称)
            'hidden' => ['app/index/controller/index'],
            'data' => [
                [
                    'name' => 'token',
                    'type' => 'string',
                    'required' => true,
                    'default' => '',
                    'desc' => '加密参数 字符串且不能为空',
                ]
            ]
        ],
        'return' => [   // 通用 返回参数
            // 不用通用返回参数 如：文件地址：app/index/controller/index 方法名称：index(),demo() ...等等
            // 1.整个class：app/index/controller/index(文件地址)
            // 2.单个函数：app/index/controller/index/demo(文件地址/方法名称)
            'hidden' => ['app/index/controller/index/demo'],      // 
            'data' => [
                [
                    'name' => 'code',
                    'type' => 'int',
                    'required' => true,
                    'desc' => '0：成功 1：失败',
                    'level' => '1',
                ],
                [
                    'name' => 'msg',
                    'type' => 'string',
                    'required' => true,
                    'desc' => '说明',
                    'level' => '1',
                ],
            ],
        ],
        'class' => [
            'app\index\controller\Index',  // 要生成帮助文档的控制器, 
            ....
        ],
        // 设置可以访问的人员，可以配置多个 user 和 label
        'auth'=>[
                'user'=>'label',    // user 和 label，就是访问地址里的 user 和 label
                'zhangsan'=>'zhangsandemo',
        ]
    ];
    ```

3.配置文件配置完成：
    编写生成帮助文档注释
    案列如下(app\index\controller\Index)：
    ```
    <?php
    namespace app\index\controller
    /**
     * @title 测试案列
     */
    class Index extends Controller
    {
        /**
         * @title 测试案列
         * @url 连接
         * @request GET
         * @desc  测试案列
         * @header {"name":"id","type":"int","required":true,"default":"","desc":"ID"}
         * @param {"name":"file","type":"文件类型","required":true,"default":"","desc":"文件"}
         * @param {"name":"size","type":"int","required":false,"default":"mp4","desc":"大小"}
         * @param {"name":"name","type":"string","required":false,"default":"名称"}
         * @return {"name":"code","type":"int","required":true,"desc":"0：成功 1：失败","level":1}
         * @return {"name":"data","type":"array","required":true,"desc":"返回数据","level":1}
         * @return {"name":"url","type":"string","required":true,"desc":"链接","level":2}
         * @return {"name":"name","type":"string","required":true,"desc":"名称","level":2}
         * @return {"name":"msg","type":"string","required":true,"desc":"失败提示","level":1}
         */
        public function index(){}
        
        /**
         * 有hidden这个函数会隐藏不会展示在接口列表中
         * @hidden
         */
        public function hidden(){}
        ...
    }
    ```

phpdaxin / apidoc

Maintainers

Details

README