README

简介

使用 API 工具集，利用高性能 API 提升您的开发之旅。通过标准化的响应、动态分页、高级过滤和一键全 CRUD 设置，为您的 API 开发提供动力。让我们将您的 API 提升到下一个层次！

🎥 视频游览

如果您想对这个包有一个更直观的了解，请观看 Laravel 包教程中的此视频。

安装

使用 Composer 安装此包

composer require essa/api-tool-kit

为什么选择 Laravel API 工具集？

一致的响应，减少麻烦

API 响应功能简化了生成一致的 JSON 响应。它为您的 API 响应提供标准化的格式

{
  "message": "your resource successfully",
  "data": [
    ...
  ]
}

正确的分页方式

不要在每页显示的结果数量上烦恼。动态分页功能可以轻松适应您的需求，让您轻松控制而无需复杂性。

$users = User::dynamicPaginate();

简化过滤

用简单的查询结果进行细化。强大的过滤系统让您轻松过滤、排序、搜索，甚至包含关系。

Car::useFilters()->get();

使用 API 生成器简化 API 设置

API 生成器自动设置文件，从迁移到控制器创建关键文件。只需一个命令即可启动您的 API 开发。

php artisan api:generate ModelName --all

支持模式

通过模式支持增强 API 生成器，允许您直接从命令行定义数据库表结构。根据此模式生成工厂模型迁移、请求和数据。

php artisan api:generate ModelName "column1:string|column2:integer|column3:datetime"

清晰的逻辑

使用操作处理复杂的业务逻辑。这些亮点遵循命令模式，提高了代码的可读性和可维护性。

app(CreateCar::class)->execute($data);

处理媒体？没问题。

像专业人士一样处理文件上传和删除。媒体助手简化了媒体管理，让您拥有整洁和有序的文件处理。

$filePath = MediaHelper::uploadFile($file, $path);

枚举以提高清晰度

Enum 类提供了一种使用枚举的方法，消除了代码中的硬编码值

namespace App\Enums;

class UserTypes extends Enum
{
    public const ADMIN = 'admin';
    public const STUDENT = 'student';
}

官方文档

访问我们的文档，解锁 Laravel API 工具集的全部潜力

探索文档

贡献

我们欢迎您的贡献，以帮助我们使此包更加完善。请参阅我们的 CONTRIBUTING.md 文件以获取贡献指南。

许可证

通过向 Laravel API 工具集做出贡献，您同意您的贡献将在项目的 MIT 许可证下许可。

essa / api-tool-kit

维护者

详细信息