Laravel API Tool Kit

https://laravelapitoolkit.com
Admin
Laravel API Tool Kit is a package designed to streamline API development in Laravel projects by...
Tokens:11,150
Snippets:114
Trust Score:5.4
Update:8 months ago
Show doc for...
Tokens:
Raw
### Install Laravel API Toolkit using Composer

Source: https://laravelapitoolkit.com/index

Installs the 'essa/api-tool-kit' package into your Laravel project using Composer. This is the initial step to begin using the package's functionalities.

```bash
composer require essa/api-tool-kit
```

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

### Publish Laravel API Toolkit Configuration Files

Source: https://laravelapitoolkit.com/index

Publishes the configuration files for the API Toolkit package to your project's config directory. This allows for customization of the package's behavior by modifying the settings in the generated configuration files.

```bash
php artisan vendor:publish --provider="Essa\APIToolKit\APIToolKitServiceProvider" --tag="config"
```

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

### Example Usage of Laravel Enum

Source: https://laravelapitoolkit.com/enum

This example illustrates how to use the UserTypes enum. It shows how to check if a value is valid using isValid(), retrieve all enum values with getAll(), and get an associative array of constants with toArray().

```php
use App\Enums\UserTypes;

// Check if a value is a valid enum value
$isStudent = UserTypes::isValid('student'); // Returns true

// Get an array of all enum values
$allUserTypes = UserTypes::getAll(); // Returns ['admin', 'student']

// Get an array of enum constants
$enumConstants = UserTypes::toArray(); // Returns ['ADMIN' => 'admin', 'STUDENT' => 'student']

```

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

### Query Records by Date and Time Range

Source: https://laravelapitoolkit.com/filters

Example of how to query records within a specific date and time range using the `DateFilter` and `TimeFilter` traits via API request parameters.

```http
/api/test-models?from_date=2023-08-01&to_date=2023-08-15&from_time=09:00:00&to_time=12:00:00
```

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

### Standardize Error Responses (Laravel 11+)

Source: https://laravelapitoolkit.com/index

Binds the exception handler to the API Toolkit's Handler class in AppServiceProvider for Laravel 11 and later. This approach replaces extending the Handler class directly and ensures standardized error formatting.

```php
<?php

namespace App\Providers;

use Essa\APIToolKit\Exceptions\Handler;
use Illuminate\Contracts\Debug\ExceptionHandler;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    public function register(): void
    {
        $this->app->bind(ExceptionHandler::class, Handler::class); // add this line 
    }
}
```

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

### Standardize Error Responses (Before Laravel 11)

Source: https://laravelapitoolkit.com/index

Extends the application's exception handler from the APIHandler class for consistent error responses in Laravel versions prior to 11. This involves updating the Handler.php file in the app/Exceptions directory.

```php
namespace App\Exceptions;

use Essa\APIToolKit\Exceptions\Handler as APIHandler;

class Handler extends APIHandler
{
}
```

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

### Retrieve All Records Without Pagination

Source: https://laravelapitoolkit.com/dynamic-pagination

This example shows how to fetch all records from an API endpoint without applying any pagination. This is achieved by setting the `pagination` parameter to `'none'` in the request URL.

```http
GET api/users?pagination=none
```

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

### Utilize API Response Trait in Controllers

Source: https://laravelapitoolkit.com/index

Integrates the ApiResponse trait into your controller classes. This trait provides methods for generating standardized API responses, simplifying the process of returning data and errors from your API endpoints.

```php
namespace App\Http\Controllers;

use Essa\APIToolKit\Api\ApiResponse;

class Controller extends BaseController
{
    use ApiResponse;
}
```

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

### Model File Fillable Attributes and Relationships

Source: https://laravelapitoolkit.com/api-generator

Example of a generated model file's `$fillable` properties and a relationship definition, based on a schema. The `$fillable` array lists attributes that can be mass-assigned, and relationships are defined as per the schema's foreign key constraints.

```php
protected $fillable = ['username', 'company_id', 'age', 'status'];

public function company()
{
    return $this->belongsTo(Company::class);
}

```

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

### Migration File Schema Definition

Source: https://laravelapitoolkit.com/api-generator

Example of a generated migration file's table schema definition, derived from the schema option. This code snippet shows how column types, nullability, foreign key constraints, and enum types are translated from the command-line schema definition into Laravel migration syntax.

```php
$table->string('username');
$table->integer('age')->nullable();
$table->foreignId('company_id')->constrained('companies');
$table->enum('status', ['old', 'new']);

```

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

### Configure Default Pagination Value in Laravel

Source: https://laravelapitoolkit.com/dynamic-pagination

This example shows how to change the default number of items displayed per page for API responses. The `default_pagination_number` setting in the `config/api-tool-kit` file can be modified to set a new default value.

```php
[
    'default_pagination_number' => 20,
]
```

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

### Upload/Delete Files to Custom Disk using Media Helper

Source: https://laravelapitoolkit.com/media-helper

Demonstrates uploading and deleting files to a custom storage disk (e.g., 's3') using the MediaHelper class. It shows how to chain the `disk()` method before other file operations.

```php
// Upload a file to the 's3' disk
$uploadedFilePath = MediaHelper::disk('s3')->uploadFile($file, $path, $fileName = null, $withOriginalName = false);

// Delete a file from the 's3' disk
MediaHelper::disk('s3')->deleteFile($filePath);

// Upload multiple files to the 's3' disk
$uploadedFilePaths = MediaHelper::disk('s3')->uploadMultiple($files, $path, $filesNames = null, $withOriginalNames = false);

// Upload a base64 image to the 's3' disk
$uploadedImagePath = MediaHelper::disk('s3')->uploadBase64Image($encodedImage, $path, $fileName = null);

// Use the default filesystem disk
$uploadedFilePath = MediaHelper::uploadFile($file, $path, $fileName = null, $withOriginalName = false);
```

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

### Upload Multiple Files using Media Helper

Source: https://laravelapitoolkit.com/media-helper

Uploads multiple files simultaneously using the MediaHelper class. It takes an array of files, a path, optional filenames, and a boolean to retain original names. Returns an array of uploaded file paths.

```php
use Essa\APIToolKit\MediaHelper;

$uploadedFilePaths = MediaHelper::uploadMultiple($files, $path, $filesNames = null, $withOriginalNames = false);
```

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

### Upload a File using Media Helper

Source: https://laravelapitoolkit.com/media-helper

Uploads a single file using the MediaHelper class. It accepts the file, a path, an optional filename, and a boolean to retain the original name. Returns the path of the uploaded file.

```php
use Essa\APIToolKit\MediaHelper;

$uploadedFilePath = MediaHelper::uploadFile($file, $path, $fileName = null, $withOriginalName = false);
```

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

### Applying Filters to Queries

Source: https://laravelapitoolkit.com/filters

Shows how to apply filters to Eloquent queries using the `useFilters()` scope.

```APIDOC
## Applying Filters

### Description
Filters can be applied to an Eloquent query using the `useFilters()` scope method provided by the `Filterable` trait.

### Method
`useFilters()`

### Endpoint
N/A (Eloquent query scope)

### Request Example
```php
use App\Models\Car;

// Apply default filters and get results
$cars = Car::useFilters()->get();
```
```

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

### Upload Base64 Image using Media Helper

Source: https://laravelapitoolkit.com/media-helper

Uploads an image provided in base64 format using the MediaHelper class. It requires the base64 encoded string, a path, and an optional filename. Returns the path of the uploaded image.

```php
use Essa\APIToolKit\MediaHelper;

$encodedImage = 'data:image/png;base64,iVBORw0KG...'; // Replace with actual base64 image data
$path = 'uploads/images'; // Destination path

// Upload the base64 image and get the uploaded image path
$uploadedImagePath = MediaHelper::uploadBase64Image($encodedImage, $path, $fileName = null);
```

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

### Creating a Filter Class

Source: https://laravelapitoolkit.com/filters

Demonstrates how to generate a new filter class using an Artisan command and how to make a model filterable.

```APIDOC
## Creating a Filter

### Description
Use the `make:filter` Artisan command to generate a new filter class. Then, use the `Filterable` trait in your model and define the default filters.

### Method
`php artisan make:filter <FilterName>`

### Endpoint
N/A (Artisan command)

### Parameters
#### Path Parameters
- **FilterName** (string) - Required - The name of the filter class to generate.

### Request Example
```bash
php artisan make:filter CarFilters
```

### Model Integration Example
```php
namespace App\Models;

use Essa\APIToolKit\Filters\Filterable;
use Illuminate\Database\Eloquent\Model;

class Car extends Model
{
    use Filterable;

    protected string $default_filters = CarFilters::class;

    // Other model code...
}
```
```

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

### Manually Create and Apply FiltersDTO

Source: https://laravelapitoolkit.com/filters

Shows how to manually create a `FiltersDTO` instance to apply custom filters, sorting, inclusion, and search parameters directly in your code, bypassing query parameters.

```php
use Essa\APIToolKit\DTO\FiltersDTO;

// Create a FiltersDTO instance manually
$filtersDTO = new FiltersDTO(
    sorts: 'created_at', // Sort by created_at in ascending order
    filters: ['name' => 'Car'], // Filter by name
    includes: ['relation'], // Include sluggableTestModel relation
    search: '2023' // Search for the year 2023
);

// Pass the custom FiltersDTO to the useFilters scope method
$records = TestModel::useFilters(filteredDTO: $filtersDTO)->get();
```

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

### Configuring Filter Options

Source: https://laravelapitoolkit.com/filters

Explains how to configure allowed filters, sorts, includes, and search parameters within a filter class.

```APIDOC
## Available Filter Options

### Description
Customize the behavior of filters within your filter class by defining properties like `$allowedFilters`, `$allowedSorts`, `$allowedIncludes`, `$columnSearch`, and `$relationSearch`.

### Method
Class properties within the filter class.

### Endpoint
N/A (Filter class configuration)

### Parameters
#### Class Properties
- **$allowedFilters** (array) - Specifies the attributes that can be used for filtering.
- **$allowedSorts** (array) - Specifies the attributes that can be used for sorting.
- **$allowedIncludes** (array) - Specifies the relationships that can be eager loaded.
- **$columnSearch** (array) - Specifies the columns that can be searched.
- **$relationSearch** (array) - Specifies the relationships and their searchable fields.

### Configuration Example
```php
namespace App\Filters;

use Essa\APIToolKit\Filters\QueryFilters;

class CarFilters extends QueryFilters
{
    protected array $allowedFilters = ['color', 'model_id'];

    protected array $allowedSorts = ['created_at'];

    protected array $allowedIncludes = ['model'];

    protected array $columnSearch = ['name', 'description'];

    protected array $relationSearch = [
        'user' => ['first_name', 'last_name']
    ];
}
```

### Sorting Example
```
// Descending sort: ?sorts=created_at
// Ascending sort: ?sorts=-created_at
```
```

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

### Date and Time Filters

Source: https://laravelapitoolkit.com/filters

Explains how to use the `DateFilter` and `TimeFilter` traits for date and time range queries.

```APIDOC
## Date and Time Filters

### Description
The `DateFilter` and `TimeFilter` traits simplify querying records within specific date or time ranges. Include these traits in your filter class to enable this functionality.

### Method
Use `DateFilter` and `TimeFilter` traits in the filter class.

### Endpoint
Example: `GET /api/test-models?from_date=2023-08-01&to_date=2023-08-15&from_time=09:00:00&to_time=12:00:00`

### Parameters
#### Query Parameters (when using traits)
- **from_date** (string) - The start date for the range (YYYY-MM-DD).
- **to_date** (string) - The end date for the range (YYYY-MM-DD).
- **from_time** (string) - The start time for the range (HH:MM:SS).
- **to_time** (string) - The end time for the range (HH:MM:SS).

### Filter Class Integration Example
```php
namespace App\Filters;

use Essa\APIToolKit\Filters\QueryFilters;
use Essa\APIToolKit\Traits\DateFilter;
use Essa\APIToolKit\Traits\TimeFilter;

class TestModelFilters extends QueryFilters
{
    use DateFilter;
    use TimeFilter;

    // ... other filter logic
}
```
```

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

### Delete a File using Media Helper

Source: https://laravelapitoolkit.com/media-helper

Deletes a file from the storage using the MediaHelper class. Requires the file path as input. This method simplifies file removal operations.

```php
use Essa\APIToolKit\MediaHelper;

MediaHelper::deleteFile($filePath);
```

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

### Creating Custom Filters

Source: https://laravelapitoolkit.com/filters

Demonstrates how to add custom filter methods to a filter class.

```APIDOC
## Creating Custom Filters

### Description
Extend the filtering capabilities by adding custom methods to your filter class. These methods can apply specific `WHERE` clauses to the query builder.

### Method
Custom public methods within the filter class.

### Endpoint
N/A (Filter class implementation)

### Parameters
- **$term** (mixed) - The value passed for the custom filter.

### Custom Filter Method Example
```php
namespace App\Filters;

use Essa\APIToolKit\Filters\QueryFilters;

class CarFilters extends QueryFilters
{
    // ... other properties

    public function year($term)
    {
        $this->builder->whereYear('manufacturing_date', $term);
    }
}
```
```

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

### Paginate with Default Settings using dynamicPaginate()

Source: https://laravelapitoolkit.com/dynamic-pagination

This snippet demonstrates how to paginate API results using the default configuration, which displays 20 items per page. It utilizes the `dynamicPaginate()` method available on your Eloquent model.

```php
$users = User::dynamicPaginate();
```

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

### Apply Filters via Query Parameters

Source: https://laravelapitoolkit.com/filters

Demonstrates how to apply filters, sorting, inclusion, and search parameters through the query parameters of an API request. This is the default method for filter application.

```http
GET /cars?color=red
GET /cars?sorts=created_at
GET /cars?includes=model,otherModel
GET /cars?search=red
```

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

### API Error Handling with Exceptions (PHP)

Source: https://laravelapitoolkit.com/general-tips

Demonstrates how to use exceptions for clear error handling in Laravel APIs. Instead of returning JSON directly, throw exceptions like AuthorizationException. The package automatically catches these exceptions and formats a standardized JSON error response, ensuring consistency across your API.

```php
public function index()
{
    if (auth()->user()->not_active ) {
        throw new AuthorizationException('you can not preform this action');
    }
}

```

```json
{
    "errors": [
        {
            "status": 403,
            "title": "Forbidden",
            "detail": "you cannot perform this action"
        }
    ]
}

```

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

### Generate API Files with Schema Definition

Source: https://laravelapitoolkit.com/api-generator

This command generates API files for a model using a schema definition. The schema is provided as a comma-separated string of column definitions (e.g., 'name:type:options'). This allows for precise control over migration and model attributes. Replace 'Customer' with your model name and define your schema accordingly.

```bash
php artisan api:generate Customer "username:string|age:integer:nullable|company_id:foreignId|status:enum(new,old)" --all

```

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

### Generate API Components with Custom Options - Bash

Source: https://laravelapitoolkit.com/api-generator

This command demonstrates generating API components for a 'Car' model using the Artisan CLI. It includes options to generate a controller, create/update request files, and enable soft delete for the model.

```bash
php artisan api:generate Car -cR --soft-delete

```

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

### Paginating with Default Settings

Source: https://laravelapitoolkit.com/dynamic-pagination

Paginate results using the default configuration of 20 items per page by calling the dynamicPaginate() method on your model.

```APIDOC
## Paginating with Default Settings

### Description
Paginate results using the default configuration of 20 items per page by calling the `dynamicPaginate()` method on your model.

### Method
Not applicable (PHP method call)

### Endpoint
Not applicable

### Parameters
None

### Request Example
```php
$users = User::dynamicPaginate();
```

### Response
#### Success Response (200)
Returns a subset of users with a default of 20 users per page.

#### Response Example
(Example response structure would depend on the User model and API structure)
```

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

### Using Filters in API Requests

Source: https://laravelapitoolkit.com/filters

Explains how filters are typically passed via query parameters in API requests.

```APIDOC
## Using Filters in Requests

### Description
By default, filtering, sorting, inclusion, and search parameters are expected in the query parameters of an API request. The `useFilters()` scope processes these parameters automatically.

### Method
Query parameters in GET requests.

### Endpoint
Example: `GET /cars?color=red&model_id=1&sorts=created_at&includes=model&search=sedan`

### Query Parameters
- **color** (string) - Example: `red` (Applies a custom filter for color).
- **model_id** (integer) - Example: `1` (Applies a custom filter for model_id).
- **sorts** (string) - Example: `created_at` or `-created_at` (For sorting).
- **includes** (string) - Example: `model,otherModel` (For eager loading relationships).
- **search** (string) - Example: `sedan` (For searching across columns).
```

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

### Generate All API Files for a Model

Source: https://laravelapitoolkit.com/api-generator

This command generates all default API-related files for a specified model. It uses the `--all` flag to include controllers, requests, resources, migrations, factories, seeders, filters, tests, and API routes. Replace 'ModelName' with your actual model name.

```bash
php artisan api:generate ModelName --all

```

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

### Customizing Filters with FiltersDTO

Source: https://laravelapitoolkit.com/filters

Shows how to manually create and use a `FiltersDTO` object to apply filters programmatically.

```APIDOC
## Customizing Filters with FiltersDTO

### Description
Override the default query parameter behavior by manually creating a `FiltersDTO` instance. This provides granular control over filter data and allows applying filters without relying on request parameters.

### Method
Manual instantiation and passing of `FiltersDTO` to `useFilters()`.

### Endpoint
N/A (Programmatic usage)

### Parameters
#### FiltersDTO Parameters
- **sorts** (string, optional) - The sorting criteria.
- **filters** (array, optional) - Key-value pairs for filtering.
- **includes** (array, optional) - Relationships to eager load.
- **search** (string, optional) - The search term.

### Request Example
```php
use Essa\APIToolKit\DTO\FiltersDTO;
use Essa\APIToolKit\Tests\Mocks\Models\TestModel;

// Create a FiltersDTO instance manually
$filtersDTO = new FiltersDTO(
    sorts: 'created_at', // Sort by created_at in ascending order
    filters: ['name' => 'Car'], // Filter by name
    includes: ['relation'], // Include sluggableTestModel relation
    search: '2023' // Search for the year 2023
);

// Pass the custom FiltersDTO to the useFilters scope method
$records = TestModel::useFilters(filteredDTO: $filtersDTO)->get();
```
```

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

### Configure Column and Relation Search

Source: https://laravelapitoolkit.com/filters

Specifies columns and relationships that can be searched using the search functionality. This allows for flexible data retrieval based on keywords.

```php
protected array $columnSearch = ['name', 'description'];
protected array $relationSearch = [
    'user' => ['first_name', 'last_name']
];
```

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

### Available Filtering Operations

Source: https://laravelapitoolkit.com/filters

Lists the standard operations supported by the filtering system and their corresponding keys.

```APIDOC
## Available Filtering Operations and Keys

### Description
This table outlines the common operations supported by the filtering system, their query parameter keys, a brief description, and an example.

### Operations Table
| Operation |
| Key |
| Description |
| Example |
|---|---|---|---|
| Search |
| `search` |
| Filters results by searching for a keyword across columns. |
| `GET /cars?search=red` |
| Sorting |
| `sorts` |
| Sorts results based on specified attributes. |
| `GET /cars?sorts=created_at` |
| Filtering |
| Custom filters (e.g., `color`, `model_id`) |
| Applies custom filters based on defined attributes. |
| `GET /cars?color=red&model_id=1` |
| Inclusion |
| `includes` |
| Eager loads specified relationships. |
| `GET /cars?includes=model,otherModel` |
```

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

### Configure Allowed Filters, Sorts, and Includes

Source: https://laravelapitoolkit.com/filters

Defines the attributes that can be used for filtering, sorting, and eager loading relationships within your filter class. This enhances security and predictability.

```php
protected array $allowedFilters = ['color', 'model_id'];

protected array $allowedSorts = ['created_at'];

protected array $allowedIncludes = ['model'];
```

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

### Customizing Pagination Per Page

Source: https://laravelapitoolkit.com/dynamic-pagination

Customize the number of items displayed per page by using the 'per_page' parameter in the request.

```APIDOC
## Customizing Pagination Per Page

### Description
Customize the number of items displayed per page by using the `per_page` parameter in the request.

### Method
GET

### Endpoint
`/api/users?per_page={number}`

### Parameters
#### Query Parameters
- **per_page** (integer) - Required - The number of items to display per page.

### Request Example
```
GET api/users?per_page=10
```

### Response
#### Success Response (200)
Returns a subset of users with the specified number of users per page.

#### Response Example
(Example response structure would depend on the User model and API structure)
```

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

### Generate API Components for a Group - Bash

Source: https://laravelapitoolkit.com/api-generator

This command generates all API components for a 'ModelName' and assigns them to the 'v1' group. This is useful for organizing API versions and applying group-specific configurations.

```bash
php artisan api:generate ModelName --all --group=v1

```

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

### Generate Factory Data with Faker - PHP

Source: https://laravelapitoolkit.com/api-generator

This factory file uses schema attributes to generate sample data for testing. It assigns corresponding Faker methods to each defined attribute. The `createOrRandomFactory()` function is a utility to create new instances or fetch random records.

```php
'username' => $this->faker->firstName(),
'age' => $this->faker->randomNumber(),
'company_id' => createOrRandomFactory(Company::class),
'status' => $this->faker->randomElement(['old', 'new'])

```

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

### Utilize Laravel Actions via Dependency Injection

Source: https://laravelapitoolkit.com/actions

Demonstrates various methods for injecting and utilizing action classes within your Laravel application. This includes direct resolution from the container, constructor injection, and controller function injection.

```php
// Using Laravel Application Container
app(CreateCar::class)->execute($data);

```

```php
// Injecting Action in Constructor
private $createCarAction ;

public function __construct(CreateCar $createCarAction)
{
    $this->createCarAction=$createCarAction;
}

public function store(Request $request)
{
    $this->createCarAction->execute($request->all());
}

```

```php
// Injecting Action in Controller Function
public function store(CreateCar $createCarAction)
{
    $createCarAction->execute($data);
}

```

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

### Customize Items Per Page in API Request

Source: https://laravelapitoolkit.com/dynamic-pagination

This snippet illustrates how to customize the number of items displayed per page in an API response. The `per_page` parameter is used in the request URL to specify the desired number of results.

```http
GET api/users?per_page=10
```

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

### Structure API Response with Resources - PHP

Source: https://laravelapitoolkit.com/api-generator

The resource file defines the structure of the API response based on schema attributes. It maps model attributes to the response structure and utilizes a `dateTimeFormat()` function for formatting datetime values.

```php
'username' => $this->username,
'age' => $this->age,
'status' => $this->status,
'company_id' => $this->company_id,
'created_at' => dateTimeFormat($this->created_at),
'updated_at' => dateTimeFormat($this->updated_at)

```

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

### Use Date and Time Filter Traits

Source: https://laravelapitoolkit.com/filters

Includes the `DateFilter` and `TimeFilter` traits in your filter class to simplify querying records within specific date and time ranges.

```php
use Essa\APIToolKit\Traits\DateFilter;
use Essa\APIToolKit\Traits\TimeFilter;

class TestModelFilters extends QueryFilters
{
    use DateFilter;
    use TimeFilter;

    // ... 
}
```

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

### Retrieving All Records Without Pagination

Source: https://laravelapitoolkit.com/dynamic-pagination

Retrieve all records without applying pagination by setting the 'pagination' parameter to 'none' in the request.

```APIDOC
## Retrieving All Records Without Pagination

### Description
Retrieve all records without applying pagination by setting the `pagination` parameter to `'none'` in the request.

### Method
GET

### Endpoint
`/api/users?pagination=none`

### Parameters
#### Query Parameters
- **pagination** (string) - Required - Set to `'none'` to disable pagination.

### Request Example
```
GET api/users?pagination=none
```

### Response
#### Success Response (200)
Returns all users without any pagination applied.

#### Response Example
(Example response structure would depend on the User model and API structure)
```

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

### Define Business Logic in Action Class

Source: https://laravelapitoolkit.com/actions

Define the core business logic for an action within its `execute` method. This method accepts data as an argument and should contain the specific operations related to the action's purpose.

```php
<?php
namespace App\Actions;

class CreateCar
{
    public function execute($data)
    {
      //add business logic to create a car
    }
}

```

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

### Generate API Files for a Specific Group (PHP)

Source: https://laravelapitoolkit.com/api-generator

Generates all API-related files (models, controllers, resources, requests, etc.) for a specified group, organizing them according to the group's custom path resolver configuration. This command requires the model name and the group identifier.

```php
php artisan api:generate ModelName --all --group=v1
```

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

### Apply Filters to Query

Source: https://laravelapitoolkit.com/filters

Applies filters to a database query using the `useFilters` scope method. This allows you to chain filter operations with other query builder methods.

```php
Car::useFilters()->get();
```

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

### Generate Laravel Action Class

Source: https://laravelapitoolkit.com/actions

Utilize the `make:action` Artisan command to generate a new action class. Replace `CreateCar` with your desired action name. This command creates the action class in the `App\Actions` namespace.

```bash
php artisan make:action CreateCar
```

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

### Generate Success Response with Data

Source: https://laravelapitoolkit.com/api-response

The `responseSuccess` method is used to create a successful JSON response. It accepts a message string and the data payload to be included in the response.

```php
$car = // Your car data here

return $this->responseSuccess('Car created successfully', $car);
```

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

### Changing Default Pagination Value

Source: https://laravelapitoolkit.com/dynamic-pagination

Configure the default number of items per page in the 'config/api-tool-kit' file by modifying the 'default_pagination_number' setting.

```APIDOC
## Changing Default Pagination Value

### Description
Configure the default number of items per page in the `config/api-tool-kit` file by modifying the `default_pagination_number` setting.

### Method
Configuration File Modification

### Endpoint
N/A

### Parameters
#### Configuration Setting
- **default_pagination_number** (integer) - The default number of elements to display per page.

### Request Example
```php
// config/api-tool-kit.php
return [
    'default_pagination_number' => 20, // Modify this value to change the default
];
```

### Response
N/A (This is a configuration change)

#### Response Example
N/A
```

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

### Configure Custom File Locations for API Groups - PHP

Source: https://laravelapitoolkit.com/api-generator

This configuration snippet shows how to define custom file locations for API groups within the `config/api-tool-kit.php` file. It allows specifying folder paths, file names, and namespaces for different generator file types within a group, such as 'v1'.

```php
'groups_files_paths' => [
    // ...other groups...
    'v1' => [
        GeneratorFilesType::MODEL => [
            'folder_path' => app_path('Models'),
            'file_name' => '{ModelName}.php',
            'namespace' => 'App\Models',
        ],
        GeneratorFilesType::CONTROLLER => [
            'folder_path' => app_path('Http/Controllers/API/V1'),
            'file_name' => '{ModelName}Controller.php',
            'namespace' => 'App\Http\Controllers\API\V1',
        ],
        // Add custom file locations for all other file types here
    ],
],

'groups_url_prefixes' => [
    'v1' => '/api/v1',
],

```

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

### Create Filter Class using Artisan

Source: https://laravelapitoolkit.com/filters

Generates a new filter class using the provided Artisan command. This class will be used to define filtering logic for your models.

```php
php artisan make:filter CarFilters
```

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

### Create Custom Filter Method

Source: https://laravelapitoolkit.com/filters

Adds custom filtering logic to your filter class by defining new methods. These methods can implement specific filtering criteria beyond the allowed filters.

```php
public function year($term)
{
    $this->builder->whereYear('manufacturing_date', $term);
}
```

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

### Generate Enum Class with Artisan

Source: https://laravelapitoolkit.com/enum

This snippet shows how to generate a new enum class using the make:enum Artisan command. Replace 'UserTypes' with your desired enum name. This command creates the enum file in the App\Enums namespace.

```php
php artisan make:enum UserTypes
```

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

### Define Enum Values and Methods

Source: https://laravelapitoolkit.com/enum

This snippet demonstrates how to define enum values as class constants within an enum class that extends the base Enum class. It also lists available methods for interacting with enums, such as getAll(), isValid(), and toArray().

```php
namespace App\Enums;

class UserTypes extends Enum
{
    public const ADMIN = 'admin';
    public const STUDENT = 'student';
}

```

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

### Define Request Validation Rules - PHP

Source: https://laravelapitoolkit.com/api-generator

Generated request files include validation rules derived from the schema. These rules specify requirements such as 'required', 'string', 'nullable', 'integer', and allowed values for specific fields.

```php
'username' => ['required', 'string'],
'age' => ['nullable', 'integer'],
'company_id' => ['required'],
'status' => ['sometimes', 'in:old,new']

```

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

### Include ApiResponse Trait in Controller

Source: https://laravelapitoolkit.com/api-response

To utilize the API Response functionality, you need to include the `ApiResponse` trait within your controller class. This makes all the response methods available for use.

```php
use Essa\APIToolKit\Api\ApiResponse;

class YourController extends Controller
{
    use ApiResponse;

    // Your methods here
}
```

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

### Generate Unauthenticated Error Response

Source: https://laravelapitoolkit.com/api-response

The `responseUnAuthenticated` method generates a standardized error response for unauthenticated requests. It requires an error detail message and an error title.

```php
return $this->responseUnAuthenticated('Unauthenticated.', 'Unauthorized');
```

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

### Use Filterable Trait in Model

Source: https://laravelapitoolkit.com/filters

Applies the Filterable trait to your Eloquent model to enable filter functionality. You can also set a default filter class for the model.

```php
namespace App\Models;

use Essa\APIToolKit\Filters\Filterable;

class Car extends Model
{
    use Filterable;

    protected string $default_filters = CarFilters::class;

    // Other model code...
}
```
Tokens:
Raw