[8.x] Add ability to customize json options on JsonResource response (#40208)

* Add ability to customize json options on JsonResource response

* Add ability to customize json options on resource collections and paginated responses

* formatting

Co-authored-by: Taylor Otwell <[email protected]>

Author: bastien-phi

src/Illuminate/Http/Resources/CollectsResources.php

@@ -54,6 +54,18 @@ class_exists($class = Str::replaceLast('Collection', 'Resource', get_class($this
         }
     }
 
+    /**
+     * Get the JSON serialization options that should be applied to the resource response.
+     *
+     * @return int
+     */
+    public function jsonOptions()
+    {
+        $collects = $this->collects();
+
+        return $collects ? (new $collects([]))->jsonOptions() : 0;
+    }
+
     /**
      * Get an iterator for the resource collection.
      *

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

@@ -164,6 +164,16 @@ public function additional(array $data)
         return $this;
     }
 
+    /**
+     * Get the JSON serialization options that should be applied to the resource response.
+     *
+     * @return int
+     */
+    public function jsonOptions()
+    {
+        return 0;
+    }
+
     /**
      * Customize the response for a request.
      *

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

@@ -23,7 +23,9 @@ public function toResponse($request)
                     $this->resource->additional
                 )
             ),
-            $this->calculateStatus()
+            $this->calculateStatus(),
+            [],
+            $this->resource->jsonOptions()
         ), function ($response) use ($request) {
             $response->original = $this->resource->resource->map(function ($item) {
                 return is_array($item) ? Arr::get($item, 'resource') : $item->resource;

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

@@ -40,7 +40,9 @@ public function toResponse($request)
                 $this->resource->with($request),
                 $this->resource->additional
             ),
-            $this->calculateStatus()
+            $this->calculateStatus(),
+            [],
+            $this->resource->jsonOptions()
         ), function ($response) use ($request) {
             $response->original = $this->resource->resource;
 

tests/Integration/Http/Fixtures/PostResourceWithJsonOptions.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Illuminate\Tests\Integration\Http\Fixtures;
+
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class PostResourceWithJsonOptions extends JsonResource
+{
+    public function toArray($request)
+    {
+        return [
+            'id' => $this->id,
+            'title' => $this->title,
+            'reading_time' => $this->reading_time,
+        ];
+    }
+
+    public function jsonOptions()
+    {
+        return JSON_PRESERVE_ZERO_FRACTION;
+    }
+}

tests/Integration/Http/ResourceTest.php

@@ -24,6 +24,7 @@
 use Illuminate\Tests\Integration\Http\Fixtures\PostResource;
 use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithAnonymousResourceCollectionWithPaginationInformation;
 use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithExtraData;
+use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithJsonOptions;
 use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithOptionalAppendedAttributes;
 use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithOptionalData;
 use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithOptionalMerging;
@@ -495,6 +496,65 @@ public function testResourcesMayCustomizeExtraDataWhenBuildingResponse()
         ]);
     }
 
+    public function testResourcesMayCustomizeJsonOptions()
+    {
+        Route::get('/', function () {
+            return new PostResourceWithJsonOptions(new Post([
+                'id' => 5,
+                'title' => 'Test Title',
+                'reading_time' => 3.0,
+            ]));
+        });
+
+        $response = $this->withoutExceptionHandling()->get(
+            '/', ['Accept' => 'application/json']
+        );
+
+        $this->assertEquals(
+            '{"data":{"id":5,"title":"Test Title","reading_time":3.0}}',
+            $response->baseResponse->content()
+        );
+    }
+
+    public function testCollectionResourcesMayCustomizeJsonOptions()
+    {
+        Route::get('/', function () {
+            return PostResourceWithJsonOptions::collection(collect([
+                new Post(['id' => 5, 'title' => 'Test Title', 'reading_time' => 3.0]),
+            ]));
+        });
+
+        $response = $this->withoutExceptionHandling()->get(
+            '/', ['Accept' => 'application/json']
+        );
+
+        $this->assertEquals(
+            '{"data":[{"id":5,"title":"Test Title","reading_time":3.0}]}',
+            $response->baseResponse->content()
+        );
+    }
+
+    public function testResourcesMayCustomizeJsonOptionsOnPaginatedResponse()
+    {
+        Route::get('/', function () {
+            $paginator = new LengthAwarePaginator(
+                collect([new Post(['id' => 5, 'title' => 'Test Title', 'reading_time' => 3.0])]),
+                10, 15, 1
+            );
+
+            return PostResourceWithJsonOptions::collection($paginator);
+        });
+
+        $response = $this->withoutExceptionHandling()->get(
+            '/', ['Accept' => 'application/json']
+        );
+
+        $this->assertEquals(
+            '{"data":[{"id":5,"title":"Test Title","reading_time":3.0}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":15,"to":1,"total":10}}',
+            $response->baseResponse->content()
+        );
+    }
+
     public function testCustomHeadersMayBeSetOnResponses()
     {
         Route::get('/', function () {