[12.x] JSON:API Resource

src/Illuminate/Foundation/Console/ResourceMakeCommand.php

@@ -51,9 +51,11 @@ public function handle()
      */
     protected function getStub()
     {
-        return $this->collection()
-            ? $this->resolveStubPath('/stubs/resource-collection.stub')
-            : $this->resolveStubPath('/stubs/resource.stub');
+        return match (true) {
+            $this->collection() => $this->resolveStubPath('/stubs/resource-collection.stub'),
+            $this->option('json-api') => $this->resolveStubPath('/stubs/resource-json-api.stub'),
+            default => $this->resolveStubPath('/stubs/resource.stub'),
+        };
     }
 
     /**
@@ -100,6 +102,7 @@ protected function getOptions()
     {
         return [
             ['force', 'f', InputOption::VALUE_NONE, 'Create the class even if the resource already exists'],
+            ['json-api', 'j', InputOption::VALUE_NONE, 'Create a JSON:API resource'],
             ['collection', 'c', InputOption::VALUE_NONE, 'Create a resource collection'],
         ];
     }

src/Illuminate/Foundation/Console/stubs/resource-json-api.stub

@@ -0,0 +1,23 @@
+<?php
+
+namespace {{ namespace }};
+
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\JsonApi\JsonApiResource;
+
+class {{ class }} extends JsonApiResource
+{
+    /**
+     * The resource's attributes.
+     */
+    public $attributes = [
+        // ...
+    ];
+
+    /**
+     * The resource's relationships.
+     */
+    public $relationships = [
+        // ...
+    ];
+}

src/Illuminate/Foundation/Testing/Concerns/InteractsWithTestCaseLifecycle.php

@@ -23,6 +23,8 @@
 use Illuminate\Foundation\Testing\WithoutMiddleware;
 use Illuminate\Http\Middleware\TrustHosts;
 use Illuminate\Http\Middleware\TrustProxies;
+use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Http\Resources\JsonApi\JsonApiResource;
 use Illuminate\Mail\Markdown;
 use Illuminate\Queue\Console\WorkCommand;
 use Illuminate\Queue\Queue;
@@ -177,6 +179,8 @@ protected function tearDownTheTestEnvironment(): void
         EncodedHtmlString::flushState();
         EncryptCookies::flushState();
         HandleExceptions::flushState($this);
+        JsonApiResource::flushState();
+        JsonResource::flushState();
         Markdown::flushState();
         Migrator::withoutMigrations([]);
         Once::flush();

src/Illuminate/Http/Resources/Json/JsonResource.php

@@ -111,8 +111,8 @@ protected static function newCollection($resource)
      */
     public function resolve($request = null)
     {
-        $data = $this->toArray(
-            $request ?: Container::getInstance()->make('request')
+        $data = $this->resolveResourceData(
+            $request ?: $this->resolveRequestFromContainer()
         );
 
         if ($data instanceof Arrayable) {
@@ -124,6 +124,32 @@ public function resolve($request = null)
         return $this->filter((array) $data);
     }
 
+    /**
+     * Transform the resource into an array.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return array|\Illuminate\Contracts\Support\Arrayable|\JsonSerializable
+     */
+    public function toAttributes(Request $request)
+    {
+        if (property_exists($this, 'attributes')) {
+            return $this->attributes;
+        }
+
+        return $this->toArray($request);
+    }
+
+    /**
+     * Resolve the resource data to an array.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return array
+     */
+    public function resolveResourceData(Request $request)
+    {
+        return $this->toAttributes($request);
+    }
+
     /**
      * Transform the resource into an array.
      *
@@ -219,6 +245,16 @@ public function withResponse(Request $request, JsonResponse $response)
         //
     }
 
+    /**
+     * Resolve the HTTP request instance from container.
+     *
+     * @return \Illuminate\Http\Request
+     */
+    protected function resolveRequestFromContainer()
+    {
+        return Container::getInstance()->make('request');
+    }
+
     /**
      * Set the string that should wrap the outer-most resource array.
      *
@@ -249,7 +285,7 @@ public static function withoutWrapping()
     public function response($request = null)
     {
         return $this->toResponse(
-            $request ?: Container::getInstance()->make('request')
+            $request ?: $this->resolveRequestFromContainer()
         );
     }
 
@@ -271,6 +307,17 @@ public function toResponse($request)
      */
     public function jsonSerialize(): array
     {
-        return $this->resolve(Container::getInstance()->make('request'));
+        return $this->resolve($this->resolveRequestFromContainer());
+    }
+
+    /**
+     * Flush the resource's global state.
+     *
+     * @return void
+     */
+    public static function flushState()
+    {
+        static::$wrap = 'data';
+        static::$forceWrapping = false;
     }
 }

src/Illuminate/Http/Resources/Json/ResourceCollection.php

@@ -96,9 +96,9 @@ public function count(): int
      * @param  \Illuminate\Http\Request  $request
      * @return array|\Illuminate\Contracts\Support\Arrayable|\JsonSerializable
      */
-    public function toArray(Request $request)
+    public function toAttributes(Request $request)
     {
-        return $this->collection->map->toArray($request)->all();
+        return $this->collection->map->resolve($request)->all();
     }
 
     /**

src/Illuminate/Http/Resources/JsonApi/AnonymousResourceCollection.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace Illuminate\Http\Resources\JsonApi;
+
+use Illuminate\Container\Container;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+use Illuminate\Support\Arr;
+
+class AnonymousResourceCollection extends \Illuminate\Http\Resources\Json\AnonymousResourceCollection
+{
+    use Concerns\ResolvesJsonApiRequest;
+
+    /**
+     * Get any additional data that should be returned with the resource array.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return array
+     */
+    #[\Override]
+    public function with($request)
+    {
+        return array_filter([
+            'included' => $this->collection
+                ->map(fn ($resource) => $resource->resolveIncludedResourceObjects($request))
+                ->flatten(depth: 1)
+                ->uniqueStrict('_uniqueKey')
+                ->map(fn ($included) => Arr::except($included, ['_uniqueKey']))
+                ->values()
+                ->all(),
+            ...($implementation = JsonApiResource::$jsonApiInformation)
+                ? ['jsonapi' => $implementation]
+                : [],
+        ]);
+    }
+
+    /**
+     * Transform the resource into a JSON array.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return array
+     */
+    #[\Override]
+    public function toAttributes(Request $request)
+    {
+        return $this->collection
+            ->map(fn ($resource) => $resource->resolveResourceData($request))
+            ->all();
+    }
+
+    /**
+     * Customize the outgoing response for the resource.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Illuminate\Http\JsonResponse  $response
+     * @return void
+     */
+    #[\Override]
+    public function withResponse(Request $request, JsonResponse $response): void
+    {
+        $response->header('Content-Type', 'application/vnd.api+json');
+    }
+
+    /**
+     * Create an HTTP response that represents the object.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\JsonResponse
+     */
+    #[\Override]
+    public function toResponse($request)
+    {
+        return parent::toResponse($this->resolveJsonApiRequestFrom($request));
+    }
+
+    /**
+     * Resolve the HTTP request instance from container.
+     *
+     * @return \Illuminate\Http\Resources\JsonApi\SparseRequest
+     */
+    #[\Override]
+    protected function resolveRequestFromContainer()
+    {
+        return $this->resolveJsonApiRequestFrom(Container::getInstance()->make('request'));
+    }
+}