properties listing

Author: robuedi

.DS_Store

@@ -2,9 +2,13 @@
 
 This project is the backend API for a properties renting app
 
+## API Endpoints UI
+
+![Properties API](/readme/properties-api.png)
+
 ## DB - ER Diagram
 
-![ER Diagram](/er-diagram.png)
+![ER Diagram](/readme/er-diagram.png)
 
 ## License
 

README.md

@@ -9,34 +9,72 @@
 use App\Models\Property;
 use App\Http\Resources\v1\PropertyResource;
 use Illuminate\Http\Response;
+use App\Http\Requests\GenericListingRequest;
 
 class PropertyController extends Controller
 {
     /**
-     * Display a listing of the resource.
+     * List properties
      */
-    public function index()
+    public function index(GenericListingRequest $request)
     {
+        $allowedFields = [
+            'id', 
+            'name',
+            'slug',
+            'owner_id',
+            'status_id',
+            'created_at',
+            'updated_at',
+            'owner.id',
+            'owner.name',
+            'status.id',
+            'status.name',  
+            'address.id', 
+            'address.city_id', 
+            'address.address_line',
+        ];
+
+        $request->validate([
+            /**
+             * Fields properties
+             * @example id,name,slug,owner_id,status_id,created_at,updated_at
+             */
+            'fields[properties]' => 'string',
+
+            /**
+             * Fields owner
+             * @example id,name
+             */
+            'fields[owner]' => 'string',
+
+            /**
+             * Fields address
+             * @example id,city_id,address_line,created_at,updated_at
+             */
+            'fields[address]' => 'string',
+
+            /**
+             * Filter name
+             * @example house
+             */
+            'filter[name]' => 'string',
+            
+            /**
+             * Relationships.
+             * @example owner,status,address,address.city,address.city.country
+             */
+            'include' => 'string',
+            'sort' => 'in:created_at,-created_at',
+        ]);
+
         $properties = QueryBuilder::for(Property::class)
-            ->allowedFields([
-                'id', 
-                'name',
-                'slug',
-                'owner_id',
-                'status_id',
-                'created_at',
-                'updated_at',
-                'owner.id',
-                'owner.name',
-                'status.id',
-                'status.name',  
-                'address.id', 
-                'address.city_id', 
-                'address.address_line',
-            ])
+            ->allowedFields($allowedFields)
             ->defaultSort('-created_at')
             ->allowedIncludes(['owner', 'status', 'address', 'address.city', 'address.city.country'])
-            ->paginate()
+            ->allowedFilters(['name'])
+            ->allowedSorts('created_at', '-created_at')
+            ->paginate(request('per_page', 15))
             ->appends(request()->query());
 
         return PropertyResource::collection($properties)->response()->setStatusCode(Response::HTTP_OK);

app/Http/Controllers/Api/v1/PropertyController.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Http\Requests;
+
+use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Validation\Rule;
+
+class GenericListingRequest extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return true;
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array<string, \Illuminate\Contracts\Validation\ValidationRule|array<mixed>|string>
+     */
+    public function rules(): array
+    {
+        return [
+            'per_page' => 'int|min:1|max:100',
+            'page' => 'int|min:1'
+        ];
+    }
+}

app/Http/Requests/GenericListingRequest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Http\Requests;
+namespace App\Http\Requests\v1;
 
 use Illuminate\Foundation\Http\FormRequest;
 
@@ -22,7 +22,6 @@ public function authorize(): bool
     public function rules(): array
     {
         return [
-            //
         ];
     }
 }

app/Http/Requests/v1/StorePropertyRequest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Http\Requests;
+namespace App\Http\Requests\v1;
 
 use Illuminate\Foundation\Http\FormRequest;
 

app/Http/Requests/v1/UpdatePropertyRequest.php

@@ -10,6 +10,7 @@
     "license": "MIT",
     "require": {
         "php": "^8.2",
+        "dedoc/scramble": "^0.11.30",
         "laravel/framework": "^11.31",
         "laravel/sanctum": "^4.0",
         "laravel/tinker": "^2.9",