xavier-iv/headless-model

Laravel 的无头模型

0.2.6 2019-06-27 07:26 UTC

This package is auto-updated.

Last update: 2024-09-29 05:28:22 UTC


README

为您的第三方 API 提供的人工模型包。

Build Status

💡 用法

$ composer require xavier-iv/headless-model

考虑以下端点

https://api.website.com/v1/user

简单地创建一个模型文件,如下所示

use XavierIV\HeadlessModel\Plan\Model;

class HeadlessUser extends Model
{
    protected $intention = 'user';
}

✨ 创建数据 - POST

在您的 Laravel 项目中如下使用它

$h_user = new HeadlessUser();
$h_user->create(['name' => 'Sam']);

✨ 获取数据 - GET

我们通常会从以下端点找到用户

https://api.website.com/v1/user/1

然后获取 ID = 1 的用户。

$h_user = (new HeadlessUser())->find(1);

💕 支持的功能

$headless->all(); 

$headless->find($id);

$headless->destroy($id);

$headless->create(['name' => 'Sam']);

💕 支持的构建器

$headless->sort('updated_at')
         ->all();
         
$headless->order($order)->all();

$headless->limit(10)->all(); 

🔥 高级功能

虽然相当罕见,但我们发现我们需要存储所有数据,通常我们会遍历它并检索通过 '下一页' 传递的数据。

有一个函数允许你实现这一点。

$headless->forceAll();

这将强制检索所有数据。警告:这可能消耗时间和资源。

🌱 提交问题

请在问题部分提交发现的问题或错误修复。

https://github.com/Xavier-IV/headless-model/issues

🌱 增强功能

目前该项目已经调整为满足我们的内部项目需求,但我们打算增加其可重用性供您使用!更多更新即将到来,特别是 RestSocket 和 RestBuilder 类。