README

本包的初始核心文件是从 ejarnutowski/laravel-api-key 克隆的

安装

运行 composer require niveka/laravel-api-key。

在您的 config/app.php 文件中，将Laravel API Key服务提供者添加到 providers 数组的末尾。

'providers' => [
    ...
    Nivekaa\LaravelApiKey\Providers\ApiKeyServiceProvider::class,
],

发布迁移文件

$ php artisan vendor:publish

运行迁移

$ php artisan migrate

将创建3个新的数据库表

• api_keys
• api_key_access_events
• api_key_admin_events

管理密钥

使用 php artisan apikey:generate {name} 生成新的密钥。名称参数是API密钥的名称。所有新密钥默认都是启用的。

$ php artisan apikey:generate app1
  
// API key created
// Name: app1
// Key: 0ZdNlr7LrQocaqz74k6usQsOsqhqSIaUarSTf8mxnHuQVh9CvKAfpUy94VvBmFMq

使用 php artisan apikey:deactivate {name} 禁用密钥。

$ php artisan apikey:deactivate app1
  
// Deactivated key: app1

使用 php artisan apikey:activate {name} 启用密钥。

$ php artisan apikey:activate app1
  
// Activated key: app1

删除密钥。您将被要求确认。密钥将 软删除 以保留记录。

$ php artisan apikey:delete app1
  
// Are you sure you want to delete API key 'app1'? (yes/no) [no]:
// > yes
  
// Deleted key: app1

列出所有密钥。 -D 或 --deleted 标志包括已删除的密钥

$ php artisan apikey:list -D
 
// +----------+----+-------------+---------------------+------------------------------------------------------------------+
// | Name     | ID | Status      | Status Date         | Key                                                              |
// +----------+----+-------------+---------------------+------------------------------------------------------------------+
// | app1     | 5  | deleted     | 2017-11-03 13:54:51 | 0ZdNlr7LrQocaqz74k6usQsOsqhqSIaUarSTf8mxnHuQVh9CvKAfpUy94VvBmFMq |
// | app2     | 1  | deleted     | 2017-11-02 22:34:28 | KuKMQbgZPv0PRC6GqCMlDQ7fgdamsVY75FrQvHfoIbw4gBaG5UX0wfk6dugKxrtW |
// | app3     | 3  | deactivated | 2017-11-02 23:12:34 | IrDlc7rSCvUzpZpW8jfhWaH235vJAqFwyzVWpoD0SLGzOimA6hcwqMvy4Nz6Hntn |
// | app4     | 2  | active      | 2017-11-02 22:48:13 | KZEl4Y2HMuL013xvg6Teaa7zHPJhGy1TDhr2zWzlQCqTxqTzyPTcOV6fIQZVTIU3 |
// +----------+----+-------------+---------------------+------------------------------------------------------------------+

用法

实现授权

已为您注册了一个新的 auth.apikey 路由中间件，您可以在路由或控制器中使用它。以下是如何使用中间件的示例，但有关详细信息，请查看Laravel文档中的 中间件。

路由示例

Route::get('api/user/1', function () {
    //
})->middleware('auth.apikey');

控制器示例

class UserController extends Controller
{
    /**
     * Instantiate a new controller instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('auth.apikey');
    }
}

授权请求

为了通过 auth.apikey 中间件，请求必须包含一个 X-Authorization 头，其值是一个有效的API密钥。

X-API-KEY: KuKMQbgZPv0PRC6GqCMlDQ7fgdamsVY75FrQvHfoIbw4gBaG5UX0wfk6dugKxrtW

未授权请求

未通过授权的请求将收到以下响应的HTTP 401状态码

{
    "success": false,
    "message": "Unautorized. Your API KEY is invalid",
}

事件历史

所有通过授权的API请求都记录在 api_key_access_events 表中。每个请求都会创建一条记录，包含以下信息

• api_key_id
• ip_address
• url
• created_at
• updated_at

每当生成、激活、停用或删除API密钥时，都会在 api_key_admin_events 表中记录一条记录。每个记录包含以下信息

• api_key_id
• ip_address
• event
• created_at
• updated_at

许可证

Laravel API Key包是开源软件，根据 MIT许可证 授权。