silverbullet/api-token-laravel

基于Token的API服务认证与授权,适用于Laravel

1.1 2021-02-06 23:45 UTC

This package is auto-updated.

Last update: 2024-09-10 06:21:40 UTC


README

Latest Version on Packagist Software License Total Downloads

设置

安装

$ composer require silverbullet/api-token-laravel

配置

将服务提供者添加到config/app.php文件中的providers数组中

'providers' => [
    ...
    Silverbullet\ApiTokenLaravel\Providers\ApiTokenServiceProvider::class
],

发布迁移文件

php artisan vendor:publish --provider="Silverbullet\ApiTokenLaravel\Providers\ApiTokenServiceProvider"

运行迁移

php artisan migrate

使用方法

API Token命令

生成新的API Token

$ php artisan api-token:generate {name} {code?}

列出所有API Token

$ php artisan api-token:list

通过id删除API Token

$ php artisan api-token:delete {id}

中间件

在Laravel路由上使用具有键apitoken.auth:{code}的中间件。示例

Route::get('partner-products', function() {
    //
})->middleware('apitoken.auth:{service1}');

您还可以为{code}传递多个参数(例如,apitoken.auth{service1,service2})。此功能使您能够授权将要使用您的API的服务。

授权请求

要传递中间件,您必须在请求中包含Authorization头。

Authorization: Basic {api_token_goes_here}

响应

  • 401: 未认证

    此错误代码表示您没有有效的Token。

  • 403: 未授权

    此错误代码表示您拥有有效的Token,但没有访问您尝试访问的API的权限。

许可

MIT许可(MIT)。有关更多信息,请参阅许可文件