使用 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 上查看源代码并做出贡献。

本文中的所有译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。

原文地址:https://laravel-news.com/laravel-restify

译文地址:https://learnku.com/laravel/t/70190

本文为协同翻译文章,如您发现瑕疵请点击「改进」按钮提交优化建议
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
讨论数量: 2

这个跟api resource有区别嘛

2周前 评论
陈先生

这个确实好用,昨天才在 laravel news 看到.

2周前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!