README

从.env文件管理API密钥访问。

安装

运行composer require ryanaby/lumen-auth-key

在你的bootstrap/app.php文件中，将Lumen Auth Key提供者添加到注册服务提供者块

// $app->register(App\Providers\AppServiceProvider::class);
// $app->register(App\Providers\AuthServiceProvider::class);
// $app->register(App\Providers\EventServiceProvider::class);
$app->register(Ryanaby\LumenAuthKey\Providers\AuthKeyServiceProvider::class);

添加密钥

在.env文件中添加你的密钥，你可以使用竖线|作为分隔符添加多个密钥。

AUTH_KEY=y0ur5ecur3K3y|an0th3rSecur3K3y

使用方法

实现授权

你可以在你的路由上使用中间件auth.apikey。

$router->get('api/post/1', ['middleware' => ['auth.apikey'], function () {
    //
}]);

传递认证

请求必须包含X-auth-key头才能访问你的API端点。

X-auth-key: y0ur5ecur3K3y

认证失败

认证失败将返回401状态码

{
    "errors": [
        {
            "message": "Unauthorized Access"
        }
    ]
}

Lumen Auth Key包是开源软件，许可协议为MIT许可。

ryanaby / lumen-auth-key

维护者

详情