[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. You need to 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 include it using include query string 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->toResource();
});

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');

[cosmastech]

This looks like it caused a breaking change in our tests. Rather than converting these to arrays, it's returning the [JsonResourceCollection].

[crynobone]

Create a new issue with reproducing repository

[cosmastech]

#58300 done

[jaketoolson]

OMG THIS BROKE EVERYTHING :(

ResourceCollection.toAttributes() from using toArray() to resolve():

It double wrapped my responses because it assumed the wrapper was 'data' (I use "value" not data ) This also added bizarre pagination in the new data wrapper that I never had before.

Rolling back to 12.44.0 resolved it without changes needed.

[AndrewMast]

@jaketoolson Did #58302 fix anything for you? It was released in v12.45.2.