使用 Restify 包在 Laravel 中构建 API

Laravel

Laravel Restify 是一个使用 Laravel 制作强大的 JSON:API 兼容的 Rest API 的包。安装软件包并遵循设置指南后，就可以使用 CLI 快速开始：

php artisan restify:repository Dream --all

存储库是这个包的核心。上面的示例命令将生成一个空白存储库，您可以向其中添加字段，如下例所示：

namespace App\Restify;

use App\Models\Dream;
use Binaryk\LaravelRestify\Http\Requests\RestifyRequest;

class DreamRepository extends Repository
{
    public static string $model = Dream::class;

    public function fields(RestifyRequest $request): array
    {
        return [
            id(),
            field('title')->required(),
            field('description'),
            field('image')->image(),
        ];
    }
}

如果你没有定义$model 属性，Restify 可以根据存储库类名称进行猜测（即，DreamRepository 将是 Dream 模型）。

下面是一个内置的 UserRepository 类的示例（您希望在实际应用中保护它），它将返回 JSON API 格式的 API 响应：

GET: /api/restify/users?perPage=10&page=2
{
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "http://localhost:8000/api/restify/users",
    "per_page": 15,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "http://localhost:8000/api/restify/users?page=1",
    "next": null,
    "path": "http://localhost:8000/api/restify/users",
    "prev": null,
    "filters": "/api/restify/users/filters"
  },
  "data": [
    {
      "id": "1",
      "type": "users",
      "attributes": {
        "name": "Paul Redmond",
        "email": "paul@example.com"
      }
    }
  ]
}

该软件包还引导你完成身份验证过程、高级过滤等！

了解更多

要开始使用，我建议观看 Restify 课程，一共有 24 节课程，介绍如何使用 Restify 和 Laravel 构建 API。你还可以阅读官方文档来安装此软件包并开始在你的应用程序中使用它。最后，你可以在 BinarCode/laravel-restify 的 GitHub 上查看源代码并做出贡献。

laravel 扩展包 composer