Filament API Service

https://github.com/rupadana/filament-api-service
Admin
Filament API Service is a Laravel package that generates REST API endpoints for Filament PHP...
Tokens:54,480
Snippets:646
Trust Score:8.7
License:MIT
Update:4 months ago
Show doc for...
Tokens:
Raw
### List Resources API Example Query

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

An example of a GET request to list resources with pagination, sorting, filtering, field selection, and eager loading of relations.

```http
GET /api/admin/blogs?page=2&per_page=10&sort=-created_at&filter[status]=published&fields=id,title,created_at
```

--------------------------------

### Run Artisan Commands for Setup and Migrations

Source: https://github.com/rupadana/filament-api-service/blob/main/TROUBLESHOOTING.md

Execute these artisan commands to set up the API service and run database migrations. Use 'install:api' for Laravel 11+.

```bash
php artisan install:api  # For Laravel 11+
php artisan migrate
```

--------------------------------

### Create API Request Command Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/commands.md

Example of using the Artisan command to generate a 'Create' request for the 'Blog' resource.

```bash
php artisan make:filament-api-request Create --resource=Blog
```

--------------------------------

### Install Filament API Service via Composer

Source: https://github.com/rupadana/filament-api-service/blob/main/README.md

Use this command to install the package. Ensure you have Composer installed.

```bash
composer require rupadana/filament-api-service
```

--------------------------------

### Resource Route Middlewares Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/configuration.md

Example of defining route middlewares within a Filament resource.

```php
class BlogResource extends Resource
{
    protected static string | array $routeMiddleware = [
        'rate_limit:api',
        'log_api_access',
    ];
}
```

--------------------------------

### Example: Customizing CreateHandler Stub

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/commands.md

This example shows how to customize the `CreateHandler.stub` file to add custom logic, such as setting a `created_by` field or modifying the success response.

```php
<?php
namespace {{ handlersNamespace }};

use Illuminate\Http\Request;
use Rupadana\ApiService\Http\Handlers;
use {{ resource }};
use {{ resourcePath }}\Api\Requests\Create{{ model }}Request;

class CreateHandler extends Handlers {
    public static string | null $uri = '/';
    public static string | null $resource = {{ resourceClass }}::class;
    protected static string $permission = 'Create:{{ model }}';

    // Customize log or audit trail here
    public function handler(Create{{ model }}Request $request)
    {
        $model = new (static::getModel());
        $model->fill($request->all());
        $model->created_by = auth()->id();  // Custom field
        $model->save();

        return static::sendSuccessResponse($model, "Successfully Create Resource");
    }
}
```

--------------------------------

### Get Single Resource API Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

An example of a GET request to retrieve a single resource by its ID, with options to select specific fields and include related data.

```http
GET /api/admin/blogs/42?fields=id,title,author&include=comments
```

--------------------------------

### Example ApiService Implementation

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Example of extending ApiService to define a specific resource, custom route group name, and handlers for a blog API.

```php
class BlogApiService extends ApiService
{
    protected static string $resource = BlogResource::class;
    protected static string $groupRouteName = 'posts';
    
    public static function handlers(): array
    {
        return [
            CreateHandler::class,
            DetailHandler::class,
            // ...
        ];
    }
}
```

--------------------------------

### Create Resource API Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

Example of a POST request to create a new resource. The request body should contain the resource's data, and the Content-Type should be application/json.

```http
POST /api/admin/blogs
Content-Type: application/json

{
    "title": "New Blog Post",
    "content": "Lorem ipsum...",
    "author_id": 1,
    "status": "draft"
}
```

--------------------------------

### Update API Request Command Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/commands.md

Example of using the Artisan command to generate an 'Update' request for the 'Blog' resource.

```bash
php artisan make:filament-api-request Update --resource=Blog
```

--------------------------------

### Setup FilamentShield

Source: https://github.com/rupadana/filament-api-service/blob/main/TROUBLESHOOTING.md

Run these commands to set up FilamentShield integration. This is typically done when encountering permission errors.

```bash
php artisan shield:setup --fresh
php artisan shield:install
```

--------------------------------

### Setup Sanctum for Laravel 11

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/getting-started.md

Install and migrate Sanctum for Laravel 11. For earlier versions, Sanctum is assumed to be already configured.

```bash
php artisan install:api
php artisan migrate
```

--------------------------------

### Login Request Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Example of a JSON payload for the login API endpoint.

```http
POST /api/auth/login
Content-Type: application/json

{
    "email": "user@example.com",
    "password": "secret"
}
```

--------------------------------

### Pagination Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

Control pagination for list endpoints using the `page` and `per_page` query parameters.

```http
GET /api/admin/blogs?page=2&per_page=25
```

--------------------------------

### Custom Transformer Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

An example of a custom transformer extending the base transformer to customize API output for a Blog model.

```php
class BlogTransformer extends JsonResource
{
    public function toArray($request)
    {
        return [
            'id' => $this->id,
            'title' => $this->title,
            'summary' => substr($this->content, 0, 100),
            'created' => $this->created_at->diffForHumans(),
        ];
    }
}
```

--------------------------------

### Get Ability

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns the permissions required for this handler in the format ['model:action']. For example, ['blog:create'].

```php
public static function getAbility(): array
```

--------------------------------

### List Tokens Response Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

This is an example of the paginated response when listing tokens. It includes the data array and pagination metadata.

```json
{
    "data": [
        {
            "id": 1,
            "name": "API Integration",
            "tokenable_id": 1,
            "abilities": ["*"],
            "created_at": "2024-01-15T10:30:00Z"
        }
    ],
    "meta": { "current_page": 1, "total": 5 }
}
```

--------------------------------

### Create Token Request Body Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

This is an example of the JSON request body used to create a new API token. It specifies the token's name, associated user ID, and abilities.

```json
{
    "name": "Mobile App Token",
    "tokenable_id": 1,
    "ability": ["blog:read", "blog:create"]
}
```

--------------------------------

### Update Resource Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

Demonstrates how to send a PUT request to update a specific resource. Ensure the Content-Type header is set to application/json.

```http
PUT /api/admin/blogs/42
Content-Type: application/json

{
    "title": "Updated Title",
    "status": "published"
}
```

--------------------------------

### Multi-Tenancy API Service Setup

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/configuration.md

Enable multi-tenancy for the API service, including tenant awareness. This configuration affects route structure to include tenant slugs.

```php
'route' => [
    'panel_prefix' => true,
],
'tenancy' => [
    'enabled' => true,
    'awareness' => true,
]
```

--------------------------------

### Example Usage of HTTP Method Constant

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/types.md

Demonstrates how to use the defined HTTP method constants within a handler class.

```php
public static function getMethod()
{
    return Handlers::POST;  // or GET, PUT, DELETE, PATCH
}
```

--------------------------------

### Complete Filament API Service Configuration Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/configuration.md

A comprehensive configuration array for the Filament API Service, covering navigation, models, routes, tenancy, login rules, and middleware settings.

```php
<?php

return [
    'navigation' => [
        'token' => [
            'cluster' => null,
            'group' => 'User',
            'sort' => -1,
            'icon' => 'heroicon-o-key',
            'should_register_navigation' => false,
        ],
    ],
    'models' => [
        'token' => [
            'enable_policy' => true,
        ],
    ],
    'route' => [
        'panel_prefix' => true,
        'use_resource_middlewares' => false,
    ],
    'tenancy' => [
        'enabled' => false,
        'awareness' => false,
    ],
    'login-rules' => [
        'email' => 'required|email',
        'password' => 'required',
    ],
    'login-middleware' => [
        // Add any additional middleware you want to apply to the login route
    ],
    'logout-middleware' => [
        'auth:sanctum',
        // Add any additional middleware you want to apply to the logout route
    ],
    'use-spatie-permission-middleware' => true,
];
```

--------------------------------

### Define API Service Commands

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/service-provider-reference.md

Returns an array of commands to be registered with the package. This example includes commands for handlers, services, transformers, and requests.

```php
protected function getCommands(): array
{
    return [
        MakeApiHandlerCommand::class,
        MakeApiServiceCommand::class,
        MakeApiTransformerCommand::class,
        MakeApiRequest::class,
    ];
}
```

--------------------------------

### Pass Script Data to JavaScript

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/service-provider-reference.md

Example of how to extend the `getScriptData()` method to pass data to JavaScript. This example passes the API base URL configuration.

```php
protected function getScriptData(): array
{
    return [
        'api_base_url' => config('api-service.base_url'),
    ];
}
```

--------------------------------

### Sorting Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

Sort results using the `sort` query parameter. Prefix field names with `-` for descending order.

```http
GET /api/admin/blogs?sort=-created_at,title
```

--------------------------------

### Relations (Includes) Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

Eagerly load related models using the `include` query parameter. Supported includes depend on the model's configuration.

```http
GET /api/admin/blogs?include=author,comments
```

--------------------------------

### Field Selection Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

Use the `fields` query parameter to select specific columns for the response, reducing data transfer.

```http
GET /api/admin/blogs?fields=id,title,created_at
```

--------------------------------

### Register ApiServicePlugin with Middleware

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/configuration.md

Configure the ApiServicePlugin during registration to include custom middleware. This example adds 'api', 'auth:sanctum', and 'throttle:api' middleware.

```php
use Rupadana\ApiService\ApiServicePlugin;

$panel->plugins([
    ApiServicePlugin::make()
        ->middleware([
            'api',
            'auth:sanctum',
            'throttle:api',
        ])
])
```

--------------------------------

### Delete Resource Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

Shows how to send a DELETE request to remove a specific resource. An Authorization header with a Bearer token is required.

```http
DELETE /api/admin/blogs/42
Authorization: Bearer {token}
```

--------------------------------

### API URL Patterns

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/README.md

Routes are grouped by panel and resource slug. Examples show common CRUD operations.

```text
/api/{panel}/{resource}           # With panel prefix (default)
/api/{resource}                   # Without panel prefix
/api/{panel}/{tenant}/{resource}  # With multi-tenancy
```

```text
Example (panel=admin, resource=blogs):
- GET /api/admin/blogs 
- GET /api/admin/blogs/42 
- POST /api/admin/blogs 
- PUT /api/admin/blogs/42 
- DELETE /api/admin/blogs/42
```

--------------------------------

### Create Custom Handler Action

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/getting-started.md

This section shows how to generate a custom handler using the Artisan command and provides an example implementation for publishing a blog post.

```APIDOC
## Create Custom Handler

Generate a custom handler:

```bash
php artisan make:filament-api-handler Blog Publish
```

Implement the handler:

```php
<?php

namespace App\Filament\Resources\Blogs\Api\Handlers;

use Illuminate\Http\Request;
use Rupadana\ApiService\Http\Handlers;
use App\Filament\Resources\Blogs\BlogResource;
use App\Models\Blog;

class PublishHandler extends Handlers
{
    public static string | null $uri = '/{id}/publish';
    public static string | null $resource = BlogResource::class;
    protected static string $permission = 'Publish:Blog';

    public static function getMethod()
    {
        return Handlers::POST;
    }

    public function handler(Request $request)
    {
        $blog = Blog::findOrFail($request->route('id'));
        
        if ($blog->status !== 'draft') {
            return static::sendSuccessResponse(
                $blog,
                'Blog is already published'
            );
        }
        
        $blog->update([
            'status' => 'published',
            'published_at' => now(),
        ]);
        
        return static::sendSuccessResponse($blog, 'Blog published successfully');
    }
}
```
```

--------------------------------

### Tenancy-Aware Pagination Handler

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/handler-patterns.md

Example of a handler that automatically filters queries by the current user's tenant when multi-tenancy is enabled.

```php
<?php

namespace App\Filament\Resources\BlogResource\Api\Handlers;

use Rupadana\ApiService\Http\Handlers;

class PaginationHandler extends Handlers
{
    public static string | null $uri = '/';
    protected static ?string $tenantOwnershipRelationshipName = 'company';

    public function handler()
    {
        // getEloquentQuery() automatically filters by tenant
        $query = static::getEloquentQuery();
        
        // Only user's tenant data returned
        return BlogTransformer::collection($query->paginate());
    }
}
```

--------------------------------

### Handler Anatomy Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/handler-patterns.md

Defines the basic structure of a handler, including URI, HTTP method, resource association, primary key, public access, and permissions.

```php
<?php

namespace App\Filament\Resources\BlogResource\Api\Handlers;

use Illuminate\Http\Request;
use Rupadana\ApiService\Http\Handlers;

class ExampleHandler extends Handlers
{
    // URI for this endpoint
    public static string | null $uri = '/';
    
    // HTTP method (get, post, put, delete, patch)
    public static string $method = 'get';
    
    // Filament resource class
    public static string | null $resource = BlogResource::class;
    
    // Primary key name for lookups
    protected static string $keyName = 'id';
    
    // Whether endpoint is public (no auth)
    public static bool $public = false;
    
    // Permission/ability required
    protected static string $permission = 'View:Blog';

    // Main request handler
    public function handler(Request $request)
    {
        // Implementation here
        return static::sendSuccessResponse($data);
    }
}
```

--------------------------------

### Get Panel

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns the current Filament panel.

```APIDOC
## getPanel(): Panel

### Description
Returns the current Filament panel.

### Method Signature
```php
public function getPanel(): Panel
```

### Returns
`Filament\Panel` - The panel instance
```

--------------------------------

### Example Usage of HasApiTransformer

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/contracts-and-traits.md

Demonstrates how to use the HasApiTransformer trait in a Filament resource to set a custom transformer.

```php
<?php

namespace App\Filament\Resources;

use Filament\Resources\Resource;
use Rupadana\ApiService\Traits\HasApiTransformer;
use App\Filament\Resources\BlogResource\Api\Transformers\BlogTransformer;

class BlogResource extends Resource
{
    use HasApiTransformer;
    
    protected static ?string $transformer = BlogTransformer::class;
    
    // ... other resource configuration
}
```

--------------------------------

### Get Route Middleware

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns middleware to apply to this route.

```APIDOC
## static::getRouteMiddleware(): array

### Description
Returns middleware to apply to this route.

### Method Signature
```php
public static function getRouteMiddleware(): array
```

### Returns
`array<string>` - Empty array if public, otherwise `['auth:sanctum', <permission-middleware>]`
```

--------------------------------

### Check Laravel and Filament Versions

Source: https://github.com/rupadana/filament-api-service/blob/main/TROUBLESHOOTING.md

Verify that your Laravel and Filament versions meet the package's requirements. Run these composer commands to check installed versions.

```bash
composer show | grep laravel/framework
composer show | grep filament/filament
```

--------------------------------

### Select Fields in API Requests

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/getting-started.md

Use the `fields` query parameter to specify which attributes to include in the API response. This example requests only the ID, title, and creation timestamp.

```bash
curl "http://localhost:8000/api/admin/blogs?fields=id,title,created_at" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

--------------------------------

### Extend API Service Assets

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/service-provider-reference.md

Example of how to extend the `getAssets()` method to register custom CSS/JS assets for the API service.

```php
protected function getAssets(): array
{
    return [
        Asset::make('api-service-styles')
            ->path('/resources/dist/api-service.css'),
    ];
}
```

--------------------------------

### Define API Service Migrations

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/service-provider-reference.md

Returns an array of migration names to be published. This example includes a single migration for creating the API service table.

```php
protected function getMigrations(): array
{
    return [
        'create_api-service_table',
    ];
}
```

--------------------------------

### Eager Load Relations in API Requests

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/getting-started.md

Use the `include` query parameter to specify relationships to eager load. This example shows how to include the 'author' and 'comments' relationships.

```bash
curl "http://localhost:8000/api/admin/blogs?include=author,comments" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

--------------------------------

### Obtain Auth Token

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

Example of a POST request to the login endpoint to obtain an authentication bearer token.

```php
POST /api/auth/login
{
    "email": "user@example.com",
    "password": "secret"
}
```

--------------------------------

### Local Package Installation via Composer

Source: https://github.com/rupadana/filament-api-service/blob/main/CONTRIBUTING.md

This snippet shows how to configure your Filament project's composer.json to use a local path for the filament-api-service package, enabling development and testing of local changes.

```json
{
"require": {
"rupadana/filament-api-service": "dev-fix/error-message as main-dev"
},
"repositories": [
{
"type": "path",
"url": "filament-api-service"
}
]
}
```

--------------------------------

### Authentication Header

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

Example of the Authorization header format required for protected endpoints, using a bearer token.

```http
Authorization: Bearer {token}
```

--------------------------------

### Get Kebab Case Class Name

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns the handler class name in kebab-case, which is used for permission mapping. For example, 'create' or 'detail'.

```php
public static function getKebabClassName()
```

--------------------------------

### Filtering Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

Filter results using the `filter` query parameter with specified operators and values. Supported filters depend on the model's configuration.

```http
GET /api/admin/blogs?filter[status]=published&filter[author_id]=1
```

--------------------------------

### Register API Service Icons

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/service-provider-reference.md

Example of how to extend the `getIcons()` method to register custom icons for the API service. The key is the icon name, and the value is the SVG content.

```php
protected function getIcons(): array
{
    return [
        'api-service-icon' => '<svg>...</svg>',
    ];
}
```

--------------------------------

### HasHandlerTenantScope Trait Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/contracts-and-traits.md

Illustrates how to use the HasHandlerTenantScope trait in a custom handler to manage multi-tenancy by specifying the tenant ownership relationship.

```php
<?php

namespace App\Filament\Resources\BlogResource\Api\Handlers;

use Rupadana\ApiService\Http\Handlers;

class PaginationHandler extends Handlers
{
    public static string | null $uri = '/';
    
    // Override tenant relationship name
    protected static ?string $tenantOwnershipRelationshipName = 'company';
}
```

--------------------------------

### Logout Request Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Example of an HTTP request for the logout API endpoint, including the Authorization header.

```http
POST /api/auth/logout
Authorization: Bearer 1|AbCdEfGhIjKlMnOpQrStUvWxYz
```

--------------------------------

### Run Migrations

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/service-provider-reference.md

Command to execute all pending database migrations, including the one for personal access tokens.

```bash
php artisan migrate
```

--------------------------------

### HttpResponse Trait: Success Response Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/contracts-and-traits.md

Demonstrates using the sendSuccessResponse method from the HttpResponse trait to return a standardized JSON success response.

```php
public function handler(Request $request)
{
    $model = Blog::find($request->id);
    return static::sendSuccessResponse($model, 'Blog retrieved successfully');
}
```

--------------------------------

### Sort API Requests

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/getting-started.md

Utilize the `sort` query parameter to order API results. This example demonstrates sorting by creation date in descending order and then by title in ascending order.

```bash
# Sort by created_at descending, then title ascending
curl "http://localhost:8000/api/admin/blogs?sort=-created_at,title" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

--------------------------------

### Get Route Middleware

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns middleware to apply to this route. This is typically an empty array for public routes or includes authentication and permission middleware.

```php
public static function getRouteMiddleware(): array
```

--------------------------------

### Test API Endpoint for Listing Blogs

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/handler-patterns.md

Tests the GET request to the /api/admin/blogs endpoint, asserting a 200 status and the presence of 'data' and 'meta' JSON paths.

```php
<?php

namespace Tests\Feature\Api;

use Tests\TestCase;
use Laravel\Sanctum\Sanctum;

class BlogApiTest extends TestCase
{
    public function test_list_blogs()
    {
        $user = User::factory()->create();
        Sanctum::actingAs($user);

        $response = $this->getJson('/api/admin/blogs');

        $response->assertStatus(200)
            ->assertHasJsonPath('data')
            ->assertHasJsonPath('meta');
    }

    public function test_create_blog()
    {
        $user = User::factory()->create();
        Sanctum::actingAs($user);

        $response = $this->postJson('/api/admin/blogs', [
            'title' => 'Test Blog',
            'content' => 'Test content',
        ]);

        $response->assertStatus(201)
            ->assertJsonPath('data.title', 'Test Blog');
    }

    public function test_unauthorized_access()
    {
        $response = $this->postJson('/api/admin/blogs', []);

        $response->assertStatus(401);
    }
}
```

--------------------------------

### HttpResponse Trait: Not Found Response Example

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/contracts-and-traits.md

Shows how to use the sendNotFoundResponse method from the HttpResponse trait to return a standardized JSON 404 error response.

```php
public function handler(Request $request)
{
    $model = Blog::find($request->id);
    if (!$model) {
        return static::sendNotFoundResponse('Blog not found');
    }
    return static::sendSuccessResponse($model);
}
```

--------------------------------

### Enable Tenant-Aware API Routes

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/configuration.md

Enable tenant-aware API routes, which include the tenant parameter. Requires tenancy.enabled and route.panel_prefix to be true.

```php
'tenancy' => [
    'awareness' => false,
],
```

--------------------------------

### Create Complete API Service

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/commands.md

Use this command to generate a new API service with all default handlers. You can then optionally customize transformers and add specific handlers.

```bash
# 1. Create API service with all handlers
php artisan make:filament-api-service Blog

# 2. (Optional) Customize transformer
# Edit: app/Filament/Resources/Blogs/Api/Transformers/BlogTransformer.php

# 3. (Optional) Add custom handlers
php artisan make:filament-api-handler Blog Publish
php artisan make:filament-api-handler Blog Archive

# 4. Verify routes
php artisan route:list | grep api
```

--------------------------------

### Get Allowed Includes

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns an array of relation names that can be eagerly loaded. Resolution order prioritizes model methods, then properties, defaulting to an empty array.

```php
public function getAllowedIncludes(): array
```

--------------------------------

### DetailHandler (Get Single Resource)

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/handler-patterns.md

Retrieves a single resource by its ID. Supports field selection and eager loading, with 404 handling for missing resources.

```APIDOC
## GET /{id}

### Description
Retrieves a single resource by its unique identifier.

### Method
GET

### Endpoint
/{id}

### Parameters
#### Path Parameters
- **id** (integer|string) - Required - The unique identifier of the resource.

#### Query Parameters
- **fields** (string) - Optional - Comma-separated list of fields to include in the response.
- **include** (string) - Optional - Comma-separated list of relationships to eager load.

### Response
#### Success Response (200)
- **id** (integer|string) - The unique identifier of the resource.
- **field1** (type) - Description of field1.
- **field2** (type) - Description of field2.

#### Response Example
```json
{
  "id": 1,
  "title": "Example Blog Post",
  "content": "This is the content.",
  "created_at": "2023-10-27T10:00:00.000Z",
  "updated_at": "2023-10-27T10:00:00.000Z"
}
```

#### Error Response (404 Not Found)
Returned when the resource with the specified ID does not exist.
```

--------------------------------

### Configure Tenancy Awareness for API Routes

Source: https://github.com/rupadana/filament-api-service/blob/main/README.md

Enable tenant-aware API routes by setting 'tenancy.awareness' to true in the published api-service.php configuration file. This will prefix API routes with '{tenant}'.

```bash
  POST      api/admin/{tenant}/blog
  GET|HEAD  api/admin/{tenant}/blog
  PUT       api/admin/{tenant}/blog/{id}
  DELETE    api/admin/{tenant}/blog/{id}
  GET|HEAD  api/admin/{tenant}/blog/{id}
```

--------------------------------

### Enable Tenant-Aware Routes

Source: https://github.com/rupadana/filament-api-service/blob/main/TROUBLESHOOTING.md

Configure the API service to enable tenant-aware routes, which include tenant slugs in the URL. This requires enabling tenancy and route panel prefix.

```php
// config/api-service.php
return [
    'route' => [
        'panel_prefix' => true, // Required for tenant awareness
    ],
    'tenancy' => [
        'enabled' => true,
        'awareness' => true, // Enable tenant-aware routes
    ],
];
```

--------------------------------

### Get Allowed Sorts

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns fields that can be sorted.

```APIDOC
## getAllowedSorts(): array

### Description
Returns fields that can be sorted.

### Method Signature
```php
public function getAllowedSorts(): array
```

### Returns
`array<string>` - Field names allowed for sorting

**Resolution order:**
1. Model's static `getAllowedSorts()` method (if implements `HasAllowedSorts`)
2. Model's `$allowedFields` property (if array) — note: uses `$allowedFields`, not `$allowedSorts`
3. Empty array
```

--------------------------------

### ApiServicePlugin Boot Method

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

The boot method is called during the plugin's boot phase. Currently, this method is empty and does not perform any actions.

```php
public function boot(Panel $panel): void
```

--------------------------------

### Constructor Method

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Initializes the handler with panel context. Automatically sets the current Filament panel if the request is for an API route.

```php
public function __construct()
```

--------------------------------

### Get Allowed Filters

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns fields that can be filtered.

```APIDOC
## getAllowedFilters(): array

### Description
Returns fields that can be filtered.

### Method Signature
```php
public function getAllowedFilters(): array
```

### Returns
`array<string>` - Field names allowed for filtering

**Resolution order:**
1. Model's static `getAllowedFilters()` method (if implements `HasAllowedFilters`)
2. Model's `$allowedFilters` property (if array)
3. Empty array
```

--------------------------------

### Publish Configuration File

Source: https://github.com/rupadana/filament-api-service/blob/main/README.md

Run this Artisan command to publish the package's configuration file to your project. This allows for customization of API service settings.

```bash
php artisan vendor:publish --tag=api-service-config
```

--------------------------------

### Configure CORS for Desktop Applications

Source: https://github.com/rupadana/filament-api-service/blob/main/TROUBLESHOOTING.md

If your desktop application accesses the API from a different domain, configure CORS settings in `config/cors.php`. This example allows all origins, but you should specify your desktop app's domain for better security.

```php
return [
    'paths' => ['api/*', 'sanctum/csrf-cookie'],
    'allowed_origins' => ['*'], // Or specify your desktop app's domain
    'allowed_methods' => ['*'],
    'allowed_headers' => ['*'],
    'exposed_headers' => [],
    'max_age' => 0,
    'supports_credentials' => true,
];
```

--------------------------------

### Get Ability

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns the permissions required for this handler.

```APIDOC
## static::getAbility(): array

### Description
Returns the permissions required for this handler.

### Method Signature
```php
public static function getAbility(): array
```

### Returns
`array<string>` - Array of ability strings based on model and handler type

**Format:** `['model:action']` (e.g., `['blog:create'])`
```

--------------------------------

### Get Allowed Includes

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns relations that can be eagerly loaded.

```APIDOC
## getAllowedIncludes(): array

### Description
Returns relations that can be eagerly loaded.

### Method Signature
```php
public function getAllowedIncludes(): array
```

### Returns
`array<string>` - Relation names allowed to be included

**Resolution order:**
1. Model's static `getAllowedIncludes()` method (if implements `HasAllowedIncludes`)
2. Model's `$allowedIncludes` property (if array)
3. Empty array
```

--------------------------------

### Generated API Routes

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/commands.md

Lists the automatically registered API routes for the generated service, including GET, POST, PUT, and DELETE methods for resource listing, detail, creation, and updates. Replace 'admin' and 'blogs' with your specific panel ID and resource slug.

```text
GET /api/admin/blogs — List blogs
GET /api/admin/blogs/{id} — Get single blog
POST /api/admin/blogs — Create blog
PUT /api/admin/blogs/{id} — Update blog
DELETE /api/admin/blogs/{id} — Delete blog
```

--------------------------------

### Get API Transformer

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns the transformer class for responses.

```APIDOC
## static::getApiTransformer(): string|null

### Description
Returns the transformer class for responses.

### Method Signature
```php
public static function getApiTransformer(): ?string
```

### Returns
`string|null` - Transformer class or `DefaultTransformer::class` if none defined
```

--------------------------------

### Create Token with Abilities

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/getting-started.md

Generate an API token for a user with specific abilities. These abilities are used for authorization when the token is presented.

```bash
php artisan tinker
```

```php
$user = User::find(1);
$token = $user->createToken('API Token', ['blog:create', 'blog:view', 'blog:update']);
echo $token->plainTextToken;
```

--------------------------------

### Get HTTP Method

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns the HTTP method for this handler.

```APIDOC
## static::getMethod(): string

### Description
Returns the HTTP method for this handler.

### Method Signature
```php
public static function getMethod()
```

### Returns
`string` - One of the HTTP method constants
```

--------------------------------

### Get Key Name

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns the primary key name for lookups.

```APIDOC
## static::getKeyName(): string|null

### Description
Returns the primary key name for lookups.

### Method Signature
```php
public static function getKeyName(): ?string
```

### Returns
`string|null` - Key name (default: `'id'`)
```

--------------------------------

### Get Allowed Fields

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns fields that can be selected via query string.

```APIDOC
## getAllowedFields(): array

### Description
Returns fields that can be selected via query string.

### Method Signature
```php
public function getAllowedFields(): array
```

### Returns
`array<string>` - Field names allowed for selection

**Resolution order:**
1. Model's static `getAllowedFields()` method (if implements `HasAllowedFields`)
2. Model's `$allowedFields` property (if array)
3. Empty array
```

--------------------------------

### Enable Multi-Tenancy

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/getting-started.md

Configure the API service to enable multi-tenancy. This involves setting 'enabled' and 'awareness' to true, and enabling the panel prefix for routes.

```php
'tenancy' => [
    'enabled' => true,
    'awareness' => true,
],
'route' => [
    'panel_prefix' => true,
],
```

--------------------------------

### Get Model

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns the Eloquent model class for this handler's resource.

```APIDOC
## static::getModel(): string

### Description
Returns the Eloquent model class for this handler's resource.

### Method Signature
```php
public static function getModel()
```

### Returns
`string` - Fully qualified model class name
```

--------------------------------

### Test List Endpoint

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/getting-started.md

Retrieve a list of resources from the API. Ensure you replace YOUR_TOKEN with the token obtained from the login endpoint.

```bash
curl -X GET http://localhost:8000/api/admin/blogs \
  -H "Authorization: Bearer YOUR_TOKEN"
```

--------------------------------

### Get Panel

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns the current Filament panel instance associated with this handler.

```php
public function getPanel(): Panel
```

--------------------------------

### Retrieving Registered Middlewares

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Get an array of all middleware classes or aliases that have been registered with the ApiServicePlugin.

```php
public function getMiddlewares(): array
```

--------------------------------

### Enable Tenancy in API Service Configuration

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/README.md

Configure the API service to enable tenancy and awareness. This will change the API routes to include tenant information.

```php
// config/api-service.php
'tenancy' => [
    'enabled' => true,
    'awareness' => true,
]
```

--------------------------------

### Get Kebab Class Name

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns kebab-case handler class name for permission mapping.

```APIDOC
## static::getKebabClassName(): string

### Description
Returns kebab-case handler class name for permission mapping.

### Method Signature
```php
public static function getKebabClassName()
```

### Returns
`string` - Handler name in kebab-case (e.g., `'create'`, `'detail'`, `'pagination'`)
```

--------------------------------

### Get HTTP Method

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns the HTTP method for this handler. Use this to determine the request method.

```php
public static function getMethod()
```

--------------------------------

### Get Key Name

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns the key name used for database queries. Defaults to 'id'.

```php
public static function getKeyName()
```

--------------------------------

### Stringify Ability

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Converts an ability array into a comma-separated string, which is used for middleware. Example: 'blog:create'.

```php
public static function stringifyAbility()
```

--------------------------------

### Show Token Resource Navigation

Source: https://github.com/rupadana/filament-api-service/blob/main/TROUBLESHOOTING.md

Set 'should_register_navigation' to true in the config file to show the Token resource in navigation.

```php
return [
    'navigation' => [
        'token' => [
            'should_register_navigation' => true, // This shows the navigation
        ],
    ],
];
```

--------------------------------

### Implement Custom Blog Publish Handler Logic

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/getting-started.md

Implement the business logic for the custom publish handler. This includes finding the blog, checking its current status, updating it to 'published', and setting the 'published_at' timestamp. It returns a success response indicating the outcome.

```php
<?php

namespace App\Filament\Resources\Blogs\Api\Handlers;

use Illuminate\Http\Request;
use Rupadana\ApiService\Http\Handlers;
use App\Filament\Resources\Blogs\BlogResource;
use App\Models\Blog;

class PublishHandler extends Handlers
{
    public static string | null $uri = '/{id}/publish';
    public static string | null $resource = BlogResource::class;
    protected static string $permission = 'Publish:Blog';

    public static function getMethod()
    {
        return Handlers::POST;
    }

    public function handler(Request $request)
    {
        $blog = Blog::findOrFail($request->route('id'));
        
        if ($blog->status !== 'draft') {
            return static::sendSuccessResponse(
                $blog,
                'Blog is already published'
            );
        }
        
        $blog->update([
            'status' => 'published',
            'published_at' => now(),
        ]);
        
        return static::sendSuccessResponse($blog, 'Blog published successfully');
    }
}
```

--------------------------------

### Get Key Name

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns the primary key name used for lookups. Defaults to 'id' if not specified.

```php
public static function getKeyName(): ?string
```

--------------------------------

### Standard API Service Configuration

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/configuration.md

Recommended configuration for the API service, including route prefixing, login rules, login middleware, and Spatie permission middleware.

```php
'route' => [
    'panel_prefix' => true,
    'use_resource_middlewares' => false,
],
'login-rules' => [
    'email' => 'required|email',
    'password' => 'required|min:8',
],
'login-middleware' => [
    'throttle:5,1',
],
'use-spatie-permission-middleware' => true
```

--------------------------------

### ApiServicePlugin::make()

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Factory method to create a new instance of the ApiServicePlugin. This is the recommended way to instantiate the plugin before configuring it.

```APIDOC
## ApiServicePlugin::make()

### Description
Factory method to create a new plugin instance.

### Method
`public static function make(): static`

### Returns
`static` — New plugin instance from the container

### Example
```php
$plugin = ApiServicePlugin::make();
```
```

--------------------------------

### Get Single Resource

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

Retrieves a single resource by its ID. Allows for field selection and eager loading of relations.

```APIDOC
## GET /api/{panel}/{resource}/{id}

### Description
Retrieves a specific resource by its unique identifier. Supports selecting specific fields and eager loading of related resources.

### Method
GET

### Endpoint
/api/{panel}/{resource}/{id}

### Parameters
#### Path Parameters
- **id** (string|int) - Required - Resource ID or key name value

#### Query Parameters
- **fields** (string) - Optional - Select specific fields comma-separated
- **include** (string) - Optional - Eagerly load relations comma-separated

### Response
#### Success Response (200 OK)
- **data** (object) - The requested resource object.

#### Response Example
```json
{
    "data": {
        "id": 1,
        "name": "Example Resource",
        "email": "user@example.com",
        "created_at": "2024-01-15T10:30:00Z"
    }
}
```

#### Error Response (404 Not Found)
- **message** (string) - Indicates that the resource was not found.

#### Response Example
```json
{
    "message": "resource not found"
}
```
```

--------------------------------

### Create Spatie Permissions

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/getting-started.md

Use Artisan Tinker to create new permissions for your application. These permissions can then be assigned to users.

```bash
php artisan tinker
```

```php
use Spatie\Permission\Models\Permission;

Permission::create(['name' => 'create_blog']);
Permission::create(['name' => 'view_any_blog']);
Permission::create(['name' => 'view_blog']);
Permission::create(['name' => 'update_blog']);
Permission::create(['name' => 'delete_blog']);
```

--------------------------------

### Get Single Resource API Response (404 Not Found)

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

This JSON structure indicates that the requested resource was not found.

```json
{
    "message": "resource not found"
}
```

--------------------------------

### Get API Transformer

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns the transformer class to be used for API responses. Defaults to DefaultTransformer::class if none is defined.

```php
public static function getApiTransformer(): ?string
```

--------------------------------

### Model with Static Properties for API Configuration

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/contracts-and-traits.md

Demonstrates how to define static properties on an Eloquent model to configure allowed fields, filters, and includes for API handlers, serving as an alternative to implementing contracts.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Product extends Model
{
    // Instead of implementing HasAllowedFields contract
    public static array $allowedFields = ['id', 'name', 'price'];
    
    // Instead of implementing HasAllowedFilters contract
    public static array $allowedFilters = ['category', 'price', 'status'];
    
    // Instead of implementing HasAllowedSorts contract
    // Note: Uses $allowedFields, not $allowedSorts
    public static array $allowedFields = ['id', 'name', 'price'];
    
    // Instead of implementing HasAllowedIncludes contract
    public static array $allowedIncludes = ['category', 'supplier'];
}
```

--------------------------------

### Get Resource

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns the fully qualified class name of the Filament resource associated with this API service. Can be null if not specified.

```php
public static function getResource()
```

--------------------------------

### Enable Multi-Tenancy

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/configuration.md

Enable multi-tenancy support. When enabled, API responses are scoped to the authenticated user's tenants. Defaults to false.

```php
'tenancy' => [
    'enabled' => false,
],
```

--------------------------------

### Get Single Token

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

Retrieves details for a specific API token by its ID. Requires ownership of the token or super_admin privileges.

```APIDOC
## GET /api/{panel}/tokens/{id}

### Description
Retrieves the details of a single API token identified by its ID. Authorization is required, ensuring the user owns the token or has super_admin privileges.

### Method
GET

### Endpoint
/api/{panel}/tokens/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the token to retrieve.
```

--------------------------------

### Interactive Prompts for make:filament-api-service

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/commands.md

When the resource name is not provided, the command will prompt for it. If multiple panels exist, it will ask which panel to use. It also prompts for the namespace if multiple are available.

```bash
What is the Resource name? Blog
```

```bash
Which panel would you like to create this in?
  [0] admin
  [1] app
```

```bash
Which namespace would you like to create this in?
  [0] App\/Filament\/Resources
  [1] App\/Filament\/Admin\/Resources
```

--------------------------------

### Configure Login Route Middleware

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/configuration.md

Add additional middleware to the login route. Common options include rate limiting and guest access.

```php
'login-middleware' => [
    'throttle:5,1',
    'guest',
],
```

--------------------------------

### Get Model

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Returns the Eloquent model class name for this handler's resource. This specifies which model the API endpoint interacts with.

```php
public static function getModel()
```

--------------------------------

### ApiServicePlugin::make() Factory Method

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/api-reference.md

Use this factory method to create a new instance of the ApiServicePlugin.

```php
public static function make(): static
```

```php
ApiServicePlugin::make();
```

--------------------------------

### Get Single Resource API Response (200 OK)

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/endpoints.md

This JSON structure represents a successful response when retrieving a single resource.

```json
{
    "data": {
        "id": 1,
        "name": "Example Resource",
        "email": "user@example.com",
        "created_at": "2024-01-15T10:30:00Z"
    }
}
```

--------------------------------

### Handler Method Configuration

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/types.md

Sets the HTTP method for a handler. Valid values include 'get', 'post', 'put', 'delete', and 'patch'.

```php
public static string $method = 'get';
```

--------------------------------

### Creating a Custom Transformer

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/contracts-and-traits.md

Shows how to create a custom JSON resource transformer for API responses.

```php
<?php

namespace App\Filament\Resources\BlogResource\Api\Transformers;

use Illuminate\Http\Resources\Json\JsonResource;

class BlogTransformer extends JsonResource
{
    public function toArray($request)
    {
        return [
            'id' => $this->id,
            'title' => $this->title,
            'slug' => $this->slug,
            'excerpt' => substr($this->content, 0, 200),
            'author_name' => $this->author->name,
            'published_at' => $this->published_at?->toIso8601String(),
            'created_at' => $this->created_at->toIso8601String(),
        ];
    }
}
```

--------------------------------

### Search Handler

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/handler-patterns.md

Handles searching for blogs by title or content. It accepts a query parameter 'q' and returns paginated results.

```APIDOC
## GET /api/admin/blogs/search

### Description
Searches for blogs based on a query string provided in the 'q' parameter. Returns paginated results of blogs matching the title or content.

### Method
GET

### Endpoint
/api/admin/blogs/search

### Parameters
#### Query Parameters
- **q** (string) - Required - The search query string.

### Response
#### Success Response (200)
- **data** (array) - Paginated list of blog results.
- **links** (object) - Pagination links.
- **meta** (object) - Pagination metadata.

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "title": "Example Blog Post",
      "content": "This is the content of the example blog post.",
      "status": "published",
      "created_at": "2023-10-27T10:00:00+00:00"
    }
  ],
  "links": {
    "first": "...",
    "last": "...",
    "prev": null,
    "next": "..."
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 10,
    "to": 1,
    "total": 1
  }
}
```

#### Error Response (400)
- **message** (string) - Indicates that the search query is required.
```

--------------------------------

### Model Implementing Multiple API Service Contracts

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/contracts-and-traits.md

Demonstrates a model implementing multiple contracts for API service functionality, including allowed fields, filters, sorts, and includes. Ensure all required contracts are implemented for full functionality.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Rupadana\ApiService\Contracts\HasAllowedFields;
use Rupadana\ApiService\Contracts\HasAllowedFilters;
use Rupadana\ApiService\Contracts\HasAllowedSorts;
use Rupadana\ApiService\Contracts\HasAllowedIncludes;

class BlogPost extends Model implements 
    HasAllowedFields,
    HasAllowedFilters,
    HasAllowedSorts,
    HasAllowedIncludes
{
    public static function getAllowedFields(): array
    {
        return ['id', 'title', 'slug', 'created_at'];
    }
    
    public static function getAllowedFilters(): array
    {
        return ['status', 'author_id', 'category'];
    }
    
    public static function getAllowedSorts(): array
    {
        return ['id', 'title', 'created_at', 'view_count'];
    }
    
    public static function getAllowedIncludes(): array
    {
        return ['author', 'comments', 'tags'];
    }
}
```

--------------------------------

### Manual API Service Structure for Clustered Resources

Source: https://github.com/rupadana/filament-api-service/blob/main/TROUBLESHOOTING.md

This illustrates the directory structure required for manually creating API services for resources within Filament clusters.

```text
app/Filament/Clusters/Catalog/Resources/
└── Products/
    ├── ProductResource.php
    └── Api/
        ├── ProductApiService.php
        ├── Transformers/
        │   └── ProductTransformer.php
        └── Handlers/
            ├── CreateHandler.php
            ├── UpdateHandler.php
            ├── DeleteHandler.php
            ├── DetailHandler.php
            └── PaginationHandler.php
```

--------------------------------

### Include Configuration Array

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/types.md

An array of relationship names that can be eagerly loaded, optimizing data retrieval by reducing N+1 query problems.

```typescript
type IncludeArray = string[]
```

```php
[
    'author',
    'comments',
    'category',
    'tags',
]
```

--------------------------------

### Set View Namespace

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/service-provider-reference.md

Specifies the prefix for loading published views.

```php
public static string $viewNamespace = 'api-service';
```

--------------------------------

### Set Package Name

Source: https://github.com/rupadana/filament-api-service/blob/main/_autodocs/service-provider-reference.md

Defines the static package name for publishing configuration and assets.

```php
public static string $name = 'api-service';
```
Tokens:
Raw