README

使用 Laravel 通过 API 密钥简单验证您的 API。本包使用以下库

• philsturgeon 的 Fractal
• maximebeaudoin 的 api-response

Laravel 11 和 PHP 8.3 现在终于支持了！

Laravel 5.3、5.4 和 5.5 现在终于支持了！

**Laravel 5.3.x 及以后版本: ~4.*

**Laravel 5.1.x 到 5.2.x: ~3.*

**Laravel 5.1.x: ~2.*

快速开始

Laravel 安装

运行 composer require coliving/api-guard

在您的 config/app.php 中，将 Chrisbjr\ApiGuard\Providers\ApiGuardServiceProvider 添加到 providers 数组的末尾

'providers' => array(

    ...
    Chrisbjr\ApiGuard\Providers\ApiGuardServiceProvider::class,
),

现在发布 api-guard 的迁移和配置文件

$ php artisan vendor:publish --provider="Chrisbjr\ApiGuard\Providers\ApiGuardServiceProvider"

然后运行迁移

$ php artisan migrate

这将设置 api_keys 表。

生成您的第一个 API 密钥

完成必要的设置后，您现在可以生成您的第一个 API 密钥。

运行以下命令以生成 API 密钥

php artisan api-key:generate

通常，ApiKey 对象是一个多态对象，这意味着它可以属于多个其他模型。

要生成一个与另一个对象（例如“用户”）关联的 API 密钥，您可以执行以下操作

+php artisan api-key:generate --id=1 --type="App\User"

要指定一个模型可以有 API 密钥，可以将 Apikeyable 特性附加到该模型

use Chrisbjr\ApiGuard\Models\Mixins\Apikeyable;

class User extends Model
{
    use Apikeyable;

    ...
}

这将向模型附加以下方法

// Get the API keys of the object
$user->apiKeys();

// Create an API key for the object
$user->createApiKey();

要生成应用程序中的 API 密钥，您可以在 ApiKey 模型中使用以下方法

$apiKey = Chrisbjr\ApiGuard\Models\ApiKey::make()

// Attach a model to the API key
$apiKey = Chrisbjr\ApiGuard\Models\ApiKey::make($model)

用法

您可以通过将 auth.apikey 中间件附加到您的 API 路由来开始使用 ApiGuard

Route::middleware(['auth.apikey'])->get('/test', function (Request $request) {
    return $request->user(); // Returns the associated model to the API key
});

这将通过需要在 X-Authorization 头部中指定的 API 密钥来有效地保护您的 API。这可以在 config/apiguard.php 中进行配置。

以下是一个示例 cURL 命令，用于演示

curl -X GET \
  http://apiguard.dev/api/test \
  -H 'x-authorization: api-key-here'

您可能还想将此中间件附加到您的 api 中间件组中的 app/Http/Kernel.php，以利用 Laravel 的其他功能，如限制。

/**
 * The application's route middleware groups.
 *
 * @var array
 */
protected $middlewareGroups = [
    ...

    'api' => [
        'throttle:60,1',
        'bindings',
        'auth.apikey',
    ],
];

如果在基本示例中注意到，您还可以通过调用 $request->user() 访问附加到 API 密钥的模型。我们在该方法中附加相关模型，因为在大多数用例中，这实际上是用户。

未经授权的请求

未经授权的请求将得到以下 JSON 格式的 401 状态响应

{
  "error": {
    "code": "401",
    "http_code": "GEN-UNAUTHORIZED",
    "message": "Unauthorized."
  }
}

ApiGuardController

ApiGuardController 利用 Fractal 和 api-response 库。

这使得我们能够轻松地创建使用模型和转换器提供标准 JSON 响应的 API。

以下是一个示例

假设您有以下模型

use Illuminate\Database\Eloquent\Model;

class Book extends Model
{
    protected $fillable = [
        'name',
    ];
}

您可以创建一个基本的控制器，它将返回所有书籍，如下所示

use Chrisbjr\ApiGuard\Http\Controllers\ApiGuardController;
use App\Transformers\BookTransformer;
use App\Book;

class BooksController extends ApiGuardController
{
    public function all()
    {
        $books = Book::all();

        return $this->response->withCollection($books, new BookTransformer);
    }
}

现在，您需要为Book对象创建变压器。变压器有助于定义和操作您希望返回到JSON响应中的变量。

use League\Fractal\TransformerAbstract;
use App\Book;

class BookTransformer extends TransformerAbstract
{
    public function transform(Book $book)
    {
        return [
            'id'         => $book->id,
            'name'       => $book->name,
            'created_at' => $book->created_at,
            'updated_at' => $book->updated_at,
        ];
    }
}

一旦您在路由中使它可用，您将从这个控制器获得以下响应

{
  "data": {
    "id": 1,
    "title": "The Great Adventures of Chris",
    "created_at": {
      "date": "2017-05-25 18:54:18",
      "timezone_type": 3,
      "timezone": "UTC"
    },
    "updated_at": {
      "date": "2017-05-25 18:54:18",
      "timezone_type": 3,
      "timezone": "UTC"
    }
  }
}

更多示例可以在GitHub页面找到： https://github.com/ellipsesynergie/api-response。

要了解更多关于变压器的信息，请访问PHP League的Fractal文档：Fractal

API验证响应

ApiGuard附带一个请求类，它可以处理您的请求验证并抛出一个标准响应。

您可以像通常一样创建一个Request类，但为了获取标准JSON响应，您必须扩展ApiGuardFormRequest类。

use Chrisbjr\ApiGuard\Http\Requests\ApiGuardFormRequest;

class BookStoreRequest extends ApiGuardFormRequest
{
    public function authorize()
    {
        return true;
    }

    public function rules()
    {
        return [
            'name' => 'required',
        ];
    }
}

现在您可以在控制器中使用它，就像您通常使用Laravel一样

use Chrisbjr\ApiGuard\Http\Controllers\ApiGuardController;
use App\Transformers\BookTransformer;
use App\Book;

class BooksController extends ApiGuardController
{
    public function store(BookStoreRequest $request)
    {
        // Request should already be validated

        $book = Book::create($request->all())

        return $this->response->withItem($book, new BookTransformer);
    }
}

如果请求未能通过验证规则，它将返回如下响应

{
  "error": {
    "code": "GEN-UNPROCESSABLE",
    "http_code": 422,
    "message": {
      "name": [
        "The name field is required."
      ]
    }
  }
}