EXAMPLES.md

Remote Models

Example use case.

It is important to note that this package is recommended to be installed on both the "host" application, the one that actually holds the original Model and its data, and the "remote" application, the one that needs to reuse/share that Model's data.

• Standard Implementation
• Custom Schema
• Custom Endpoint

---

Standard Implementation

Host

REMOTE_MODELS_API_KEY="abcdefghijklmnopqrstuvwxyz"

// config/remote-models.php
return [
    'host-models' => [
        \App\Models\Celebrity::class,
    ],
];

// app/Models/Celebrity.php
namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Celebrity extends Model
{    
    protected $fillable = [
        'name',
        'birthday',
    ];
}

Remote

REMOTE_MODELS_API_KEY="abcdefghijklmnopqrstuvwxyz"

// config/remote-models.php
return [
    'domain' => 'https://host-application-domain.com', // http://127.0.0.1:8000
];

// app/Models/Celebrity.php
namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Celebrity extends Model
{
    use \RemoteModels\RemoteModel;
}

---

Custom Schema Implementation

Host

REMOTE_MODELS_API_KEY="abcdefghijklmnopqrstuvwxyz"

// config/remote-models.php
return [
    'host-models' => [
        \App\Models\Celebrity::class,
    ],
];

// app/Models/Celebrity.php
namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Celebrity extends Model
{    
    protected $fillable = [
        'name',
        'birthday',
        'stage_name',
    ];
}

Remote

REMOTE_MODELS_API_KEY="abcdefghijklmnopqrstuvwxyz"

// config/remote-models.php
return [
    'domain' => 'https://host-application-domain.com', // http://127.0.0.1:8000
];

// app/Models/Celebrity.php
namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Celebrity extends Model
{
    use \RemoteModels\RemoteModel;    
    
    protected array $remoteSchema = [
        'name' => 'string',
        'birthday' => 'datetime',
        // stage_name not given, therefore it will not be stored on the "remote" application.
    ];
}

---

Custom Endpoint Implementation

Host

REMOTE_MODELS_API_KEY="abcdefghijklmnopqrstuvwxyz"

// config/remote-models.php
return [
    'host-models' => [
        // Nothing, you shouldn't put anything here for a Model with a custom endpoint.
        // Otherwise, it will auto-create an API route.
    ],
];

// app/Models/Celebrity.php
namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Celebrity extends Model
{    
    protected $fillable = [
        'name',
        'birthday',
    ];
}

// routes/web.php (the "/api" prefix is already applied in the config)
use App\Models\Celebrity;
use RemoteModels\Http\Requests\CustomRemoteModelRequest;

Route::post(
    config('remote-models.api-path') . '/v1/celebrities',
    fn (CustomRemoteModelRequest $request) => $request->returnRemoteModels(Celebrity::class)
);

Remote

REMOTE_MODELS_API_KEY="abcdefghijklmnopqrstuvwxyz"

// config/remote-models.php
return [
    'domain' => 'https://host-application-domain.com', // http://127.0.0.1:8000
];

// app/Models/Celebrity.php
namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Celebrity extends Model
{
    use \RemoteModels\RemoteModel;
    
    protected string $remoteEndpoint = '/v1/celebrities'
}