## 配置參數 安裝模塊后`application\apidoc\config\apidoc.php`的配置文件，可配置的參數說明 ## title * 類型: string * 默認值: APi接口文檔 頁面的標題，顯示在左上角與封面頁 ## desc * 類型: string 文檔封面處顯示 ## copyright * 類型: string * 默認值: Powered By HG 頁面的標題，版權申明，顯示在封面頁 ## controllers * 類型: Array * 默認值: undefined 列出需要生成接口文檔的控制器 ~~~ // config/apidoc.php <?php return [ //生成文檔的控制器 'controllers' => [ 'api\\controller\\ApiTest', 'api\\controller\\User', ... ], ] ~~~ ## versions * 類型: Array * 默認值: undefined 設置API文檔的版本 ~~~ // config/apidoc.php <?php return [ //設置可選版本 'versions'=>[ ['title'=>'V1.0','folder'=>'v1'], ['title'=>'V2.0','folder'=>'v2'], ], ] ~~~ ## groups * 類型: Array * 默認值: undefined 設置控制器分組 ~~~ // config/apidoc.php <?php return [ //設置控制器分組 'groups'=>[ ['title'=>'基礎模塊','name'=>'base'], ['title'=>'示例模塊','name'=>'demo'], ], ] ~~~ ## with_cache * 類型: boolean * 默認值: false 是否開啟緩存，開啟后，如存在緩存數據優先取緩存數據，開啟后需手動更新接口參數，關閉則每次刷新重新生成接口數據 ## responses * 類型: string * 默認值: 如下示例 統一的請求響應體，此配置只做展示用 ~~~ // config/apidoc.php <?php return [ // 統一的請求響應體 'responses'=>'{ "code":"狀態碼", "message":"操作描述", "data":"業務數據", "timestamp":"響應時間戳" }', ] ~~~ ## global_auth_key * 類型: string * 默認值: Authorization 設置全局Authorize時請求頭headers攜帶的key，對應token的key ## auth * 類型: Array 進入接口問頁面的權限認證配置 ### auth.with_auth * 類型: boolean * 默認值:false 是否啟用權限認證，啟用則需登錄 ### auth.auth_password * 類型: string * 默認值:123456 進入接口文檔頁面的登錄密碼 ## definitions * 類型: string * 默認值: app\\common\\controller\\Definitions 指定公共注釋定義的控制器地址 ## filter_method * 類型: array * 默認值: 如下示例 指定公共注釋定義的控制器地址 ~~~ // config/apidoc.php <?php return [ // 過濾、不解析的方法名稱 'filter_method'=>[ '_empty', '_initialize', '__construct', '__destruct', '__get', '__set', '__isset', '__unset', '__cal', ] ] ~~~