TP5接口文档管理

ThinkPHP5 API自动生成 layui美化

使用方法

安装扩展

composer require okcoder/think5-apidoc dev-master

配置参数

5.0版本
安装好扩展后在 application\extra\ 文件夹下会生成 okcoder_doc.php 配置文件
5.1版本
安装好扩展后在 application\config\ 文件夹下会生成 okcoder_doc.php 配置文件

<?phpreturn [    'title'         => 'apidoc',                   # 文档title    'version'       => '3.0',                               # 文档版本    'copyright'     => 'Powered By OkCoder',          # 版权信息    'password'      => '',                                  # 访问密码，为空不需要密码    'qq'            => '1046512080',                        # 咨询QQ    'document'      => [        "explain" => [            'name' => '说明',            'list' => [                '登录态'      => ['11'],                'formId收集' => ['222', '2222'],                '邀请有礼'     => ['333', '33333', '33333']            ]        ],        "code"    => [            'name' => '返回码',            'list' => [                '0'     => '成功',                '1'     => '失败'            ]        ]    ],     // 全局请求header,一般存放token之类的    'header'        => [    ],    // 全局请求参数    'params'        => [        '__uid' => 2    ],    // 需要生成文档的类(单版本)    'controller'    => [        'index/controller/Demo',        'index/controller/Demo2',    ],    // 过滤、不解析的方法名称    'filter_method' => [        '_empty'    ]];

单版本配置

新建控制器app/index/controller/Demo.php

<?phpnamespace app\index\controller;use think\Controller;/** * @title   模块名称 * @desc    我是模块名称 * Class Index * @package app\index\controller */class Demo extends Controller{    /**     * @title 方法1     * @desc  类的方法1     * @url   url('index/demo/index',true,'',true)     *     * @param int $page  0 999     * @param int $limit 10     *     * @return int $id 0 索引     * @return int $id 0 索引     * @return int $id 0 索引     */     public function index(){}}

修改okcoder_doc.php 配置文件

'controller' => [    'index/controller/Demo',    'index/controller/Demo2',]

多版本配置新建控制器app/index/controller/v2/Demo.php

<?phpnamespace app\index\controller\v2;use think\Controller;/** * @title   模块名称 * @desc    我是模块名称 * Class Index * @package app\index\controller\v2 */class Demo extends Controller{    /**     * @title 方法1     * @desc  类的方法1     * @url   url('index/v2.demo/index',true,'',true)     *     * @param int $page  0 999     * @param int $limit 10     *     * @return int $id 0 索引     * @return int $id 0 索引     * @return int $id 0 索引     */     public function index(){}}

修改okcoder_doc.php 配置文件

    'controller' => [        [            'name'=>'v2版本',            'list'=>[                'index\controller\v2\Demo', //控制器的命名空间+控制器名称(不需要加\\app)                'index\controller\v2\Demo', //支持两层控制器URL自动生成                'index\controller\v2\Demo'            ]        ],        [            'name'=>'v3版本',            'list'=>[                'index\controller\v3\Demo', //控制器的命名空间+控制器名称(不需要加\\app)                'index\controller\v3\Demo', //支持两层控制器URL自动生成                'index\controller\v3\Demo'            ]        ]    ]