访问密码

全局密码

配置文件apidoc.php中的 auth 设置如下，即可在访问文档页面时需输入密码访问：

// apidoc.php
// 权限认证配置
'auth' => [
    // 是否启用密码验证
    'enable'     => true,
    // 验证密码
    'password'   => "123456",
    // 密码加密盐
    'secret_key' => "apidoc#hg_code",
    // 有效期
    'expire' => 24*60*60
],

应用/版本独立密码

apidoc.php配置文件将指定应用/版本，设置password字段，便可开启该应用的访问密码

// /config/apidoc.php

'apps'           => [
    ['title'=>'后台管理','path'=>'app\admin\controller','key'=>'admin','password'=>'123'],
    [
        'title'=>'演示示例',
        'key'=>'demo',
        'items'=>[
            ['title'=>'V1.0','path'=>'app\demo\controller\v1','key'=>'v1'],
            ['title'=>'V2.0','path'=>'app\demo\controller\v2','key'=>'v2','password'=>'456']
        ]
    ]
],

如上配置，访问admin应用需要使用123进行密码校验；访问demo 的v2时需要456进行密码校验

注意

由于Apidoc的异常状态会经过框架的异常处理，所以如果框架的异常处理函数，无正常返回401状态码时，可能会导致开启密码访问功能后，页面报错。可参考常见问题-访问授权错误