Generate API documentation with scramble

app/Http/Resources/IdAndNameResource.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Resources;
 
 use Illuminate\Http\Request;
@@ -15,8 +17,8 @@ class IdAndNameResource extends JsonResource
     public function toArray(Request $request): array
     {
         return [
-            'id' => $this->id,
-            'name' => $this->name
+            'id' => (int) $this->id,
+            'name' => $this->name,
         ];
     }
 }

app/Http/Resources/OrganisationResource.php

@@ -17,7 +17,7 @@ class OrganisationResource extends JsonResource
     public function toArray(Request $request): array
     {
         return [
-            'id' => $this->id,
+            'id' => (int) $this->id,
             'name' => $this->name,
             'type' => $this->type,
             'status' => $this->status,
@@ -29,7 +29,7 @@ public function toArray(Request $request): array
             'activity_counties' => IdAndNameResource::collection($this->activityCounties),
             'created_at' => $this->created_at->format('Y-m-d H:i:s'),
             'updated_at' => $this->updated_at->format('Y-m-d H:i:s'),
-            'volunteers_count' => $this->volunteers_count,
+            'volunteers_count' => (int) $this->volunteers_count,
         ];
     }
 }

composer.json

@@ -7,6 +7,7 @@
     "require": {
         "php": "^8.1",
         "alcea/cnp": "^3.0",
+        "dedoc/scramble": "^0.8.5",
         "filament/filament": "^2.17",
         "filament/spatie-laravel-media-library-plugin": "^2.17",
         "guzzlehttp/guzzle": "^7.8",

config/scramble.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+use Dedoc\Scramble\Http\Middleware\RestrictedDocsAccess;
+
+return [
+    /*
+     * Your API path. By default, all routes starting with this path will be added to the docs.
+     * If you need to change this behavior, you can add your custom routes resolver using `Scramble::routes()`.
+     */
+    'api_path' => 'api',
+
+    /*
+     * Your API domain. By default, app domain is used. This is also a part of the default API routes
+     * matcher, so when implementing your own, make sure you use this config if needed.
+     */
+    'api_domain' => null,
+
+    'info' => [
+        /*
+         * API version.
+         */
+        'version' => env('API_VERSION', '1'),
+
+        /*
+         * Description rendered on the home page of the API documentation (`/docs/api`).
+         */
+        'description' => '',
+    ],
+
+    /*
+     * Customize Stoplight Elements UI
+     */
+    'ui' => [
+        /*
+         * Hide the `Try It` feature. Enabled by default.
+         */
+        'hide_try_it' => false,
+
+        /*
+         * URL to an image that displays as a small square logo next to the title, above the table of contents.
+         */
+        'logo' => '',
+
+        /*
+         * Use to fetch the credential policy for the Try It feature. Options are: omit, include (default), and same-origin
+         */
+        'try_it_credentials_policy' => 'include',
+    ],
+
+    /*
+     * The list of servers of the API. By default, when `null`, server URL will be created from
+     * `scramble.api_path` and `scramble.api_domain` config variables. When providing an array, you
+     * will need to specify the local server URL manually (if needed).
+     *
+     * Example of non-default config (final URLs are generated using Laravel `url` helper):
+     *
+     * ```php
+     * 'servers' => [
+     *     'Live' => 'api',
+     *     'Prod' => 'https://scramble.dedoc.co/api',
+     * ],
+     * ```
+     */
+    'servers' => null,
+
+    'middleware' => [
+        'web',
+        RestrictedDocsAccess::class,
+    ],
+
+    'extensions' => [],
+];

routes/api.php

@@ -17,6 +17,8 @@
 | is assigned the "api" middleware group. Enjoy building your API!
 |
 */
+Gate::define('viewApiDocs', fn () => true);
+
 Route::middleware('auth:sanctum')
     ->prefix('/v1')
     ->group(function () {