Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ This is how our `app/Http/routes.php` will look:
<?php
Route::group(['namespace' => 'Api'], function() {
Route::resource('employees', 'EmployeesController');
Route::resource('orders', 'OrdersController');
Route::get(
'employees/{employee_id}/orders', [
'as' => 'employees.orders',
Expand Down Expand Up @@ -334,6 +335,16 @@ class EmployeesTransformer implements JsonApiMapping
{
return [];
}

/**
* Returns an array of properties that are mandatory to be passed in when doing create or update.
*
* @return array
*/
public function getRequiredProperties()
{
return [];
}
}
```

Expand Down Expand Up @@ -516,8 +527,10 @@ Let's create a new controller that extends the `JsonApiController` provided by t

**Lumen users must extends from `LumenJsonApiController` not `JsonApiController`**.

**Employees Controller**

```php
<?php namespace App\Http\Controllers;
<?php namespace App\Http\Controllers\Api;

use App\Model\Database\Employees;
use NilPortugues\Laravel5\JsonApi\Controller\JsonApiController;
Expand All @@ -537,6 +550,30 @@ class EmployeesController extends JsonApiController
}
```

**Orders Controller**

```php
<?php namespace App\Http\Controllers\Api;

use App\Model\Database\Orders;
use NilPortugues\Laravel5\JsonApi\Controller\JsonApiController;

class OrdersController extends JsonApiController
{
/**
* Return the Eloquent model that will be used
* to model the JSON API resources.
*
* @return \Illuminate\Database\Eloquent\Model
*/
public function getDataModel()
{
return new Orders();
}

}
```


In case you need to overwrite any default behaviour, the **JsonApiController** methods are:

Expand Down Expand Up @@ -573,6 +610,9 @@ If you look inside the `listAction`you'll find a code similar to the one below,

use App\Model\Database\Employees;
use App\Model\Database\Orders;
use Illuminate\Http\Request;
use NilPortugues\Api\JsonApi\Http\Factory\RequestFactory;
use NilPortugues\Laravel5\JsonApi\Actions\ListResource;
use NilPortugues\Laravel5\JsonApi\Controller\JsonApiController;

class EmployeesController extends JsonApiController
Expand Down