RestQL 项目使用教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00014/article/details/139793148

RestQL 项目使用教程

restql 📦 A data resolution package for your Laravel models. 项目地址: https://gitcode.com/gh_mirrors/re/restql

1. 项目介绍

RestQL 是一个基于 Laravel 模型的数据解析包，旨在通过采用 GraphQL 的原则，仅解决客户端请求的数据。RestQL 使用 Laravel 模型作为入口点，基于 Eloquent 方法添加查询。通过 RestQL，您可以优化数据请求，减少不必要的数据传输，从而提高应用性能。

2. 项目快速启动

2.1 安装 RestQL

首先，使用 Composer 安装 RestQL：

composer require gregorip02/restql

2.2 发布配置文件

安装完成后，发布 RestQL 的配置文件：

php artisan restql:schema

2.3 添加 RestQL 特性到模型

在您的 Eloquent 模型中添加 RestqlAttributes 特性：

use Illuminate\Database\Eloquent\Model;
use Restql\Traits\RestqlAttributes;

class Author extends Model
{
    use RestqlAttributes;
}

2.4 生成授权器

为您的模型生成授权器：

php artisan restql:authorizer AuthorAuthorizer

这将在 App\Restql\Authorizers 命名空间下生成一个 AuthorAuthorizer 类。

2.5 配置授权器

在生成的授权器中添加可用的 HTTP 方法：

namespace App\Restql\Authorizers;

use Restql\Authorizer;

final class AuthorAuthorizer extends Authorizer
{
    public static function get(array $clausules = []): bool
    {
        return true;
    }
}

2.6 定义 Schema

在 config/restql.php 文件中定义您的 Schema：

return [
    'schema' => [
        'authors' => [
            'class' => \App\Models\Author::class,
            'authorizer' => \App\Restql\Authorizers\AuthorAuthorizer::class,
            'middlewares' => []
        ]
    ]
];

2.7 配置路由

在 routes/api.php 中配置 RestQL 的路由：

use Restql\Restql;
use Illuminate\Http\Request;

Route::get('/restql', fn (Request $request) => Restql::resolve($request));

2.8 客户端请求示例

在客户端代码中，您可以通过发送参数来请求所需的数据：

const [ stringify ] = require('qs');

const getAuthorsQuery = {
    authors: {
        select: ['name']
    }
};

fetch(`https://laravel-app/restql?${stringify(getAuthorsQuery)}`)
    .then((res) => res.json())
    .then((res) => console.log(res));

3. 应用案例和最佳实践

3.1 优化数据请求

假设您有一个管理作者的应用程序，作者可以发布文章，文章可以有来自不同作者的评论。通过 RestQL，您可以仅请求作者的名称，而不需要获取其他不必要的数据。

3.2 动态加载关联数据

在某些情况下，您可能需要动态加载关联数据。例如，您可能需要获取每个作者的最后两篇文章的标题。通过 RestQL，您可以轻松实现这一点：

const getAuthorsAndTwoLatestArticlesQuery = {
    authors: {
        select: ['name'],
        with: {
            articles: {
                take: 2,
                select: 'title',
                sort: {
                    column: 'published_at',
                    direction: 'desc'
                }
            }
        }
    }
};

fetch(`https://laravel-app/restql?${stringify(getAuthorsAndTwoLatestArticlesQuery)}`)
    .then((res) => res.json())
    .then((res) => console.log(res));