wip

.vscode/settings.json

@@ -1,3 +1,4 @@
 {
-  "php-cs-fixer.executablePath": "${workspaceFolder}/vendor/bin/php-cs-fixer"
-}
+  "php-cs-fixer.executablePath": "${workspaceFolder}/vendor/bin/php-cs-fixer",
+  "php.version": "8.3.1"
+}

config/apiable.php

@@ -54,4 +54,21 @@
         'include_ids_on_attributes' => false,
     ],
 
+    /**
+     * Default options for responses like: normalize relations names, include allowed filters and sorts, etc.
+     *
+     * @see https://docs.opensoutheners.com/laravel-apiable/guide/documentation.html
+     */
+    'documentation' => [
+
+        'markdown' => [
+            'base_path' => 'storage/exports/markdown',
+        ],
+
+        'postman' => [
+            'base_path' => 'storage/exports',
+        ],
+
+    ],
+
 ];

src/Attributes/AppendsQueryParam.php

@@ -3,6 +3,7 @@
 namespace OpenSoutheners\LaravelApiable\Attributes;
 
 use Attribute;
+use OpenSoutheners\LaravelApiable\Support\Facades\Apiable;
 
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 final class AppendsQueryParam extends QueryParam
@@ -11,4 +12,13 @@ public function __construct(public string $type, public array $attributes, publi
     {
         //
     }
+
+    public function getTypeAsResource(): string
+    {
+        if (! str_contains($this->type, '\\')) {
+            return $this->type;
+        }
+
+        return Apiable::getResourceType($this->type);
+    }
 }

src/Attributes/FieldsQueryParam.php

@@ -3,6 +3,7 @@
 namespace OpenSoutheners\LaravelApiable\Attributes;
 
 use Attribute;
+use OpenSoutheners\LaravelApiable\Support\Facades\Apiable;
 
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 final class FieldsQueryParam extends QueryParam
@@ -11,4 +12,13 @@ public function __construct(public string $type, public array $fields, public st
     {
         //
     }
+
+    public function getTypeAsResource(): string
+    {
+        if (! str_contains($this->type, '\\')) {
+            return $this->type;
+        }
+
+        return Apiable::getResourceType($this->type);
+    }
 }

src/Attributes/FilterQueryParam.php

@@ -3,6 +3,8 @@
 namespace OpenSoutheners\LaravelApiable\Attributes;
 
 use Attribute;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Str;
 use OpenSoutheners\LaravelApiable\Http\QueryParamValueType;
 
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]

src/Attributes/ResourceResponse.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace OpenSoutheners\LaravelApiable\Attributes;
+
+class ResourceResponse
+{
+    /**
+     * @param  class-string<\Illuminate\Database\Eloquent\Model>  $resource
+     */
+    public function __construct(public string $resource)
+    {
+        //
+    }
+}