[12.x] JSON:API Resource

[crynobone]

This PR allows you to output your API Resources using JSON:API specification instead of normal JSON via JsonResource. Without refactoring existing code you can do this using:

use App\Models\User;
use Illuminate\Support\Facades\Route;

Route::get('/users/{user}', function (User $user) {
-   return $user->toResource();
+   return $user->toResource()->asJsonApi();
});

You can also update your existing resource class to extends JsonApiResource instead of JsonResource:

-use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Http\Resources\JsonApi\JsonApiResource;

-class UserResource extends JsonResource
+class UserResource extends JsonApiResource
{

Relationships

The response from JsonApiResource will not lazy load relationships, you need to manually eager-loads it using the following code:

use App\Models\User;
use Illuminate\Support\Facades\Route;

Route::get('/users/{user}', function (User $user) {
    return $user->loadMissing('posts')->toResource()->asJsonApi();
});

You can utilise query string format such as /users/11?include=posts,teams using the following code:

use App\Models\User;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;

Route::get('/users/{user}', function (Request $request, User $user) {
    return $user->loadMissing(implode(',', $request->query('include')))->toResource()->asJsonApi();
});

Server Implementation

You can configure jsonapi object https://jsonapi.org/format/#document-jsonapi-object on each response using JsonApiResource::configure() method.

use Illuminate\Http\Resources\JsonApi\JsonApiResource;

JsonApiResource::configure(version: '2.0.0');