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 '' 執行方法
     */