yoctu/api-guardian

用令牌保护您的API(objective-php)

v1.3.1 2018-09-20 12:18 UTC

This package is auto-updated.

Last update: 2024-09-20 04:39:04 UTC


README

Build Status

使用令牌保护您的页面!

先决条件

您需要运行Objective-PHP的项目来使用此包。

如果您想使用用户令牌功能,您需要一个具有apiToken属性的用戶。使用yoctu/connect,您至少需要connect-common v2.2.3

安装

安装此包应该很容易。您只需将其仓库添加到您的composer.json中

composer require yoctu/api-guardian

并根据需要将包添加到您的Application.php中,使用过滤器。

$this->getStep('auth')
    ->plug(Apiguardian::class, new UrlFilter('/api/*'))->as('api-guardian')
;

使用包

现在该包已连接到您的应用程序,您可以在配置中设置一个或多个令牌。

return [
    new Param('api-keys', ['api_key_one', 'api_key_two'])
];

您现在需要向请求中添加一个令牌以通过中间件

GET / HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Authorization: api_key_one
Connection: keep-alive

运行测试

./vendor/bin/phpunit --bootstrap vendor/autoload.php tests

许可证

此项目受GNU GPL 3.0许可证许可 - 有关详细信息,请参阅LICENSE文件