Generate API documentation with scramble (#154)

code4romania · Mar 7, 2024 · 4f9e085 · 4f9e085
1 parent d4628a5
commit 4f9e085
Show file tree

Hide file tree

Showing 13 changed files with 307 additions and 56 deletions.
diff --git a/app/Filament/Pages/Auth/Settings.php b/app/Filament/Pages/Auth/Settings.php
@@ -4,6 +4,7 @@
 
 namespace App\Filament\Pages\Auth;
 
+use Filament\Forms\Components\Hidden;
 use Filament\Forms\Components\TextInput;
 use JeffGreco13\FilamentBreezy\Pages\MyProfile;
 
@@ -41,4 +42,15 @@ protected function getUpdateProfileFormSchema(): array
                 ->label(__('user.field.email')),
         ];
     }
+
+    protected function getCreateApiTokenFormSchema(): array
+    {
+        return [
+            TextInput::make('token_name')
+                ->label(__('filament-breezy::default.fields.token_name'))
+                ->required(),
+
+            Hidden::make('abilities'),
+        ];
+    }
 }
diff --git a/app/Http/Controllers/OrganisationController.php b/app/Http/Controllers/OrganisationController.php
@@ -6,11 +6,14 @@
 
 use App\Http\Resources\OrganisationResource;
 use App\Models\Organisation;
+use Illuminate\Http\Resources\Json\JsonResource;
 
 class OrganisationController extends Controller
 {
-    public function __invoke()
+    public function __invoke(): JsonResource
     {
+        $this->authorize('accessApi');
+
         return OrganisationResource::collection(
             Organisation::query()
                 ->withoutEagerLoads(['city'])

diff --git a/app/Http/Controllers/ResourceController.php b/app/Http/Controllers/ResourceController.php
@@ -6,11 +6,14 @@
 
 use App\Http\Resources\ResourceResource;
 use App\Models\Resource;
+use Illuminate\Http\Resources\Json\JsonResource;
 
 class ResourceController extends Controller
 {
-    public function __invoke()
+    public function __invoke(): JsonResource
     {
+        $this->authorize('accessApi');
+
         return ResourceResource::collection(
             Resource::query()
                 ->with([

diff --git a/app/Http/Resources/IdAndNameResource.php b/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,
         ];
     }
 }
diff --git a/app/Http/Resources/OrganisationResource.php b/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,
         ];
     }
 }
diff --git a/app/Providers/AppServiceProvider.php b/app/Providers/AppServiceProvider.php
@@ -6,6 +6,9 @@
 
 use App\Filament\Pages\Auth\Settings;
 use Carbon\Carbon;
+use Dedoc\Scramble\Scramble;
+use Dedoc\Scramble\Support\Generator\OpenApi;
+use Dedoc\Scramble\Support\Generator\SecurityScheme;
 use Filament\Facades\Filament;
 use Filament\Navigation\UserMenuItem;
 use Illuminate\Database\Eloquent\Model;
@@ -52,6 +55,12 @@ public function boot()
                     ->icon('heroicon-o-cog'),
             ]);
         });
+
+        Scramble::extendOpenApi(function (OpenApi $openApi) {
+            $openApi->secure(
+                SecurityScheme::http('bearer', 'JWT')
+            );
+        });
     }
 
     public function registerReleaseVersion(): void

diff --git a/app/Providers/AuthServiceProvider.php b/app/Providers/AuthServiceProvider.php
@@ -4,10 +4,12 @@
 
 namespace App\Providers;
 
+use App\Models\User;
 use Illuminate\Auth\EloquentUserProvider;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
 use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\Gate;
 
 class AuthServiceProvider extends ServiceProvider
 {
@@ -33,5 +35,13 @@ public function boot()
             return (new EloquentUserProvider($app['hash'], $config['model']))
                 ->withQuery(fn (Builder $query) => $query->withoutGlobalScopes());
         });
+
+        Gate::define('accessApi', function (User $user) {
+            if (! config('filament-breezy.enable_sanctum')) {
+                return false;
+            }
+
+            return $user->isPlatformAdmin();
+        });
     }
 }
diff --git a/composer.json b/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",

diff --git a/composer.lock b/composer.lock
diff --git a/config/filament-breezy.php b/config/filament-breezy.php
@@ -117,5 +117,7 @@
     |--------------------------------------------------------------------------
     | Sanctum permissions
     */
-    'sanctum_permissions' => ['create', 'read', 'update', 'delete'],
+    'sanctum_permissions' => [
+        // 'create', 'read', 'update', 'delete',
+    ],
 ];