1. 程式人生 > 實用技巧 >TP5.1 自動生成API文件(註釋)

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

預覽

這是我本地連結,你訪問不到的哈哈哈

註釋