medianet-dev/api-tool-kit

一套用于使用Laravel构建API的工具

1.3.0 2024-02-21 17:33 UTC

This package is auto-updated.

Last update: 2024-09-21 18:49:49 UTC


README

Latest Version on Packagist Total Downloads

简介

使用API Toolkit提升您的开发之旅,利用高性能API。通过标准化响应、动态分页、高级过滤和一键全CRUD设置来超级强化您的API开发。让我们将您的API提升到下一个层次!

安装

使用Composer安装此包

composer require medianet-dev/api-tool-kit

为什么选择Laravel API Toolkit?

一致的响应,更少的麻烦

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

{
    "base_url": "APP_URL",
    "status": true,
    "message": "OK",
    "status_code": 200,
    "message": "your message",
    "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);

枚举以提高清晰度

枚举类提供了一种处理枚举的方法,消除了代码中的硬编码值

namespace App\Enums;

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

许可

通过为Laravel API Toolkit做出贡献,您同意您的贡献将根据项目的MIT许可证进行许可。