Laravel 5.6 Api - 搜索、排序和过滤数据列表

Question

您好，我正在开发一个用于检索分页用户列表的 REST API 端点。在前端，可以选择搜索所有列出的列、按所有列排序以及按名称、状态和创建日期过滤。

到目前为止，我已经在用户模型中创建了一个存储库和本地范围，用于搜索、排序和过滤。到目前为止，这是我的代码。我对过滤器选项感到困惑。由于用户具有所有三个选项的呼叫过滤器。如何以最优化的方式在 api 中传递这些值？

控制器：

public function index(Request $request)
{
    $this->userRepository->getAllUsers($request);
}

存储库功能：

public function getAllUsers($request)
{
    // Search Parameter
    isset($request->q)? $q = $request->q: $q = null;

    // Sort Parameter
    if ( isset($request->sortby) && (isset($request->direction)) ) {
        $sort[$request->sortby] = $request-> direction;
    }

    return User::where('type','=','student')
                ->ofSearch($q)
                ->ofSort($sort)
                ->paginate($per_page)
}

型号：

public function scopeOfSearch($query, $q)
{
    if ( $q ) {
        $query->orWhere('name', 'LIKE', '%' . $q . '%')
              ->orWhere('school', 'LIKE', '%' . $q . '%')
              ->orWhere('email', 'LIKE', '%' . $q . '%')
              ->orWhere('phone', 'LIKE', '%' . $q . '%')
              ->orWhere('class', 'LIKE', '%' . $q . '%');
    }

    return $query;
}

public function scopeOfSort($query, $sort = [])
{
    if ( ! empty($sort) ) {
        foreach ( $sort as $column => $direction ) {
            $query->orderBy($column, $direction);
        }
    } 
    else {
        $query->orderBy('users.name'); 
    }

    return $query;
}

Answer 1

我会以这种方式更改您的存储库的代码：

public function getAllUsers($request)
{
    // Set query builder
    $qb = User::query();
    if($request->has('q')){
        $qb->ofSearch($q);
    }
    if($request->has('sortby')){
        //Handle default parameter of get with second argument
        $qb->orderBy($request->get('sortBy'), $request->get('direction', 'ASC'));
    }

    return $qb->paginate();
}

Request::get 方法句柄为您检查！

Answer 2

无论如何，我修复了它，我创建了另一个帖子端点，它将发送所有过滤器及其值。我不确定这是否是正确的方法，但现在我只能这样想。

更新

我已经按照下面的教程实现了过滤器。

https://m.dotdev.co/writing-advanced-eloquent-search-query-filters-de8b6c2598db

Answer 3

对于需要使用 Laravel API 对数据库数据进行排序和过滤的人来说，这是一个简单的解决方案（在 Laravel 5.x 和 6.1 中测试过）。

首先： 在数据库中创建您的表。您可以手动执行测试提案，但我建议您遵循以下说明：https://laravel.com/docs/5.7/migrations

在该示例中，表被命名为“my_task”；

然后在 Laravel 根目录中创建你的模型：

php artisan make:model MyTask（返回：模型创建成功。）

模型将在 app 目录中创建。

接下来，在 Laravel 根目录中输入您的控制器：

php artisan make:controller MyTaskController（返回：控制器创建成功。）

控制器将在app/Http/Controllers/ 内部创建 之后，在控制器MyTaskController.php文件中插入以下代码：

<?php

namespace App\Http\Controllers;

use App\MyTask;
use DB;
use Illuminate\Http\Request;

class MyTaskController extends Controller
{
       public function filter($parameter)
                {
                        $filter = DB::table('my_task')
                                ->where('field123', '=', $parameter)
                                ->get();
                        return $filter;
                }
}

最后： 在routes/api.php 文件中添加指向您的控制器的路由：

Route::get("my-task/{parameter}", "MyTaskController@filter");

使用浏览器或 Postman 测试您的端点：

http://127.0.0.1/api/my-task/value

在上面的url中，“value”是你要在数据库my-task表中查找的值。

Ps：您可以创建指向同一控制器内其他功能的新路由，以进行其他类型的操作，如“排序”。