https://github.com/netbuild/apidriver
An Eloquent model and query builder with support for Restful Api Server using the original Laravel API.
https://github.com/netbuild/apidriver
laravel laravel-framework laravel-model laravel-package laravel-service-provider query-builder restful-api
Last synced: 4 months ago
JSON representation
An Eloquent model and query builder with support for Restful Api Server using the original Laravel API.
- Host: GitHub
- URL: https://github.com/netbuild/apidriver
- Owner: netbuild
- Created: 2021-01-06T21:06:21.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-28T15:15:22.000Z (over 4 years ago)
- Last Synced: 2025-01-17T12:17:50.643Z (5 months ago)
- Topics: laravel, laravel-framework, laravel-model, laravel-package, laravel-service-provider, query-builder, restful-api
- Language: PHP
- Homepage:
- Size: 52.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API Driver for Laravel 8.0
An Eloquent model and query builder with support for Restful Api Server using the original Laravel API. This library extends the original Laravel classes, so it uses exactly the same methods. Supports relationships to other models with methods like hasMany, belongsTo, etc.
Works great with other Laravel instances.
### Installation
---------------
Installation using composer:
```bash
composer require netbuild/apidriver
```
And add the service provider in `config/app.php`:
```php
Netbuild\Apidriver\ApiDbServiceProvider::class
```
### Configuration
----------------
Change your default database connection name in `config/database.php`:
```php
'default' => 'api'
```
And add a new api server connection:
```php
'api' => [
'driver' => 'api',
]
```
### Usage
--------
Create new Model extend Api Eloquent Model:
```php
use Netbuild\Apidriver\Eloquent\Model;
class User extends Model
{
protected $url = 'https://api.your_restful.url';
protected $api_token = 'YOUR_API_TOKEN';
protected $table = 'REMOTE_MODEL';
}
```
Using the original Eloquent API:
```php
$users = User::where('id', '<', 100)->take(3)->get();
```
or
```php
$users = User::where('column_1', '=', 'your_term_1')->orWhere('column_1', '=', 'your_term_2')->take(3)->get();
```
or
```php
$user = User::find(3);
```
or
```php
$user->delete();
```
### Relationships
-------------
Model User
```php
belongsTo(User::class);
}
}
```