TP5.1 自动生成API文档（注释）

安装

在phpstorm中请求一直报错，只能老老实实在项目文件夹cmd了

composer require okcoder/think5-apidoc dev-master

配置

官方文档说会在config目录里自动生成okcoder_doc.php，我的没有，只能自己创建了

<?php
/**
 * Created by PhpStorm.
 * User: Administrator
 * Date: 2020/11/14
 * Time: 11:45
 */

return [
    'title'         => 'apidoc',                            # 文档title
    'version'       => '3.0',                               # 文档版本
    'copyright'     => 'Powered By Zyf',                　  # 版权信息
    'password'      => '',                                  # 访问密码，为空不需要密码
    'qq'            => '1322816443',                        # 咨询QQ
    'document'      => [
        "explain" => [
            'name' => '说明',
            'list' => [
                '欢迎页'      => ['欢迎查看api'],
            ]
        ],
        "code"    => [
            'name' => '返回码',
            'list' => [
                '200'     => '成功',
                '501'     => '失败'
            ]
        ]
    ],
    // 全局请求header,一般存放token之类的
    'header'        => [

    ],
    // 全局请求参数
    'params'        => [
        '__uid' => 2
    ],
    // 需要生成文档的类(多版本)
    'controller' => [
        [
            'name' => '小程序',
            'list' => [
                'api\controller\Index',
            ]
        ],
    ],
    // 过滤、不解析的方法名称
    'filter_method' => [
        '_empty'
    ]
];

修改

 

 

 

 找到这个文件打开，ctrl + f

<script src="{$assets}/layui/layui.js"></script>

把他删了

 

 

 找到他，把他复制到public目录下，然后回到base.html目录下，在head中复制

<script src="/layui.js"></script>

然后去百度一个logo，也放到public目录下

 

 

 也是base.html中，把logo图片更改一下，不知道为什么源码路径报错

运行

http://你的域名/doc

http://你的域名/index.php/doc

预览

这是我本地链接，你访问不到的哈哈哈

 

 

 注释

/**
 * @title   微信小程序
 * @desc    公共类
 * Class Index
 * @package app\api\controller\
 */
class Index extends Controller
{

    /**
     * @title pc入口
     * @desc 检查请求的控制器和方法存不存在，然后验证token是否过期，有没有权限
     * @url  url('api/Index/index',true,'',true)
     * @version 1.0
     *
     * @author zyf
     *
     * @param string $action '' 方法
     * @param string $access_id '' 用户id
     *
     * @return string false '' 接口不存在
     * @return bool true '' 执行方法
     */