Laravel API Toolkit（laravel接口工具包）

Laravel  /  管理员 发布于 1年前   441

Laravel API Toolkit（应用程序接口工具包）通过标准化响应、动态分页等功能为你的应用程序接口开发增色不少。

目前，它支持以下功能：

模式支持
分页助手
API 生成器命令
API 过滤
操作
媒体助手
还有更多...

使用提供的 api:generate Artisan 命令，

您可以轻松生成所需的所有关键文件，包括控制器、请求、资源、模型、迁移等：

php artisan api:generate Customer \
  "username:string|age:integer:nullable|company_id:foreignId|status:enum(new,old)" \
  --all

运行上述命令后，将创建以下文件，为您提供开始构建客户 API 所需的一切：

过滤是该软件包的另一个有用功能，它可以让你定义哪些字段可以进行过滤。

以汽车模型为例，过滤器配置如下：

namespace App\Models;
 
use Essa\APIToolKit\Filters\Filterable;
 
class Car extends Model
{
    use Filterable;
 
    protected string $default_filters = CarFilters::class;
 
    // Other model code...
}

而 CarFilters 类可能是这样的：

namespace App\Filters;
 
use Essa\APIToolKit\Filters\QueryFilters;
 
class CarFilters extends QueryFilters
{
    protected array $allowedFilters = ['color', 'model_id'];
 
    protected array $columnSearch = [];
}
 
// GET /cars?color=red

操作是该软件包的另一项功能，您可以使用它将业务逻辑封装在不同的类中，并用这些类来组成

namespace App\Actions;
 
class CreateCar
{
    public function execute($data)
    {
      // ...
    }
}
 
// usage example in a controller
public function store(Request $request)
{
    $this->createCar->execute($request->all());
}

要开始使用此软件包，请查看官方文档。

https://laravelapitoolkit.com/

您可以在GitHub上了解有关此软件包的更多信息、获得完整的安装说明并查看源代码。

https://github.com/ahmedesa/laravel-api-tool-kit