coverage test

- Fixed API doc functions
- Added tests for api doc functions

Author: dash8x

src/Concerns/ApiDocHelpers.php

@@ -87,7 +87,7 @@ public static function apiDocMaxPerPage(): int
         return $new_instance->getMaxPerPage();
     }
 
-    public function apiDocAllowUnlimitedResultsPerPage(): bool
+    public static function apiDocAllowUnlimitedResultsPerPage(): bool
     {
         /** @var self $new_instance */
         $new_instance = app(static::class);
@@ -194,9 +194,16 @@ public static function apiDocDefaultQueryParameters(
 
                 $metadata = $filter_metadata[$filter_name] ?? [];
 
+                $filter_title = Str::of($filter_name)
+                    ->replaceMatches('/([a-z])([A-Z])/', '$1 $2') // Split camelCase: pEnding → p Ending
+                    ->replace('_', ' ')                    // Replace custom separator (e.g. _ or space) with space
+                    ->lower()                                     // Lowercase everything
+                    ->title()                                     // Capitalize words
+                    ->toString();
+
                 $params["filter[{$filter_name}]"] = array_merge([
                     'type' => 'string',
-                    'description' => is_string($filter) ? 'Filter by the ' . Str::lower(slug_to_title($filter))  . ' of the ' . $singular_resource_name : 'Apply the ' . Str::lower(slug_to_title($filter_name)) . ' filter',
+                    'description' => is_string($filter) ? 'Filter by the ' . Str::lower($filter_title)  . ' of the ' . $singular_resource_name : 'Apply the ' . Str::lower($filter_title) . ' filter',
                 ], $metadata);
             }
         }

src/Concerns/IsApiController.php

@@ -288,7 +288,18 @@ protected function modifyQuery(\Spatie\QueryBuilder\QueryBuilder $query): \Spati
      */
     public function getAllowedAppendAttributes(): array
     {
-        return Arr::rootKeys($this->getAllowedAppends());
+        $appends = $this->getAllowedAppends();
+        $keys = [];
+
+        foreach ($appends as $key => $value) {
+            if (is_array($value)) {
+                $keys[] = $key;
+            } else {
+                $keys[] = $value;
+            }
+        }
+
+        return $keys;
     }
 
     /**
@@ -298,7 +309,19 @@ public function getAllowedAppendAttributes(): array
      */
     public function getShowAllowedAppendAttributes(): array
     {
-        return Arr::rootKeys($this->getAllShowAllowedAppends());
+
+        $appends = $this->getAllShowAllowedAppends();
+        $keys = [];
+
+        foreach ($appends as $key => $value) {
+            if (is_array($value)) {
+                $keys[] = $key;
+            } else {
+                $keys[] = $value;
+            }
+        }
+
+        return $keys;
     }
 
     /**

tests/Feature/ApiControllerTest.php

@@ -29,6 +29,81 @@ protected function registerApiRoutes()
         Route::get('/products/{id}', [ProductsController::class, 'show'])->name('products.show');
     }
 
+    #[Test]
+    public function it_can_get_index_method_api_doc_metadata(): void
+    {
+        $params = ProductsController::apiDocControllerMethodMetadata('index');
+
+        $this->assertIsArray($params);
+
+        $this->assertEquals('Products', $params['groupName']);
+        $this->assertEquals('Endpoints for listing and viewing products', $params['groupDescription']);
+        $this->assertEquals('List all products', $params['title']);
+        $this->assertEquals('Fetch all products. Supports filtering, sorting, pagination and field selection.', $params['description']);
+    }
+
+    #[Test]
+    public function it_can_get_show_method_api_doc_metadata(): void
+    {
+        $params = ProductsController::apiDocControllerMethodMetadata('show');
+
+        $this->assertIsArray($params);
+
+        $this->assertEquals('Products', $params['groupName']);
+        $this->assertEquals('Endpoints for listing and viewing products', $params['groupDescription']);
+        $this->assertEquals('View a single product', $params['title']);
+        $this->assertEquals('Fetch a single product. Supports field selection.', $params['description']);
+    }
+
+    #[Test]
+    public function it_can_get_other_methods_api_doc_metadata(): void
+    {
+        $params = ProductsController::apiDocControllerMethodMetadata('fake');
+
+        $this->assertIsArray($params);
+
+        $this->assertEquals('Products', $params['groupName']);
+        $this->assertEquals('Endpoints for listing and viewing products', $params['groupDescription']);
+
+        $this->assertArrayNotHasKey('title', $params);
+        $this->assertArrayNotHasKey('description', $params);
+    }
+
+    #[Test]
+    public function it_can_get_index_method_api_doc_query_params(): void
+    {
+        $params = ProductsController::apiDocControllerMethodQueryParameters('index');
+
+        $this->assertIsArray($params);
+
+        $this->assertArrayHasKey('fields', $params);
+        $this->assertArrayHasKey('include', $params);
+        $this->assertArrayHasKey('append', $params);
+        $this->assertArrayHasKey('sort', $params);
+        $this->assertArrayHasKey('per_page', $params);
+        $this->assertArrayHasKey('page', $params);
+        $this->assertArrayHasKey('filter[name]', $params);
+        $this->assertArrayHasKey('filter[search]', $params);
+    }
+
+    #[Test]
+    public function it_can_get_show_method_api_doc_query_params(): void
+    {
+        $params = ProductsController::apiDocControllerMethodQueryParameters('show');
+
+        $this->assertIsArray($params);
+
+        $this->assertArrayHasKey('fields', $params);
+        $this->assertArrayHasKey('include', $params);
+        $this->assertArrayHasKey('append', $params);
+
+        $this->assertArrayNotHasKey('sort', $params);
+        $this->assertArrayNotHasKey('per_page', $params);
+        $this->assertArrayNotHasKey('page', $params);
+        $this->assertArrayNotHasKey('filter[name]', $params);
+        $this->assertArrayNotHasKey('filter[search]', $params);
+    }
+
     #[Test]
     public function it_can_list_api_models(): void
     {