filament-api - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #golang #machine-learning #rust #deep-learning #linux #java #cli #awesome-list #vue #ios #mcp

filament-api

(★ 54)

Generate APIs from your filament resource using single line of code

File Explorer

Download Latest Version (.zip)

- FUNDING.yml
- 3x1io-tomato-api.jpg
- api-resource.png
- .gitkeep
- filament-api.php
- api.php
- - .gitkeep
  - FilamentApiInstall.php
- - FilamentAPI.php
- - APIResponse.php
- - .gitkeep
  - APIResource.php
- - FilamentAPIServices.php
- - InteractWithAPI.php
- FilamentAPIPlugin.php
- FilamentApiServiceProvider.php
- - .gitkeep
- - .gitkeep
3x1io-tomato-api.md
CHANGELOG.md
composer.json
LICENSE.md
module.json
README.md
SECURITY.md

# Installation Guide

1. Get the code

git clone https://github.com/tomatophp/filament-api

Downloads the entire project code from GitHub to your computer.

cd filament-api

Moves into the project folder you just downloaded.

2. PHP (Composer)

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

composer require tomatophp/filament-api

Type this command into your terminal and run it.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Screenshot](https://raw.githubusercontent.com/tomatophp/filament-api/master/arts/3x1io-tomato-api.jpg)

# Resource API Generator

[![Latest Stable Version](https://poser.pugx.org/tomatophp/filament-api/version.svg)](https://packagist.org/packages/tomatophp/filament-api)
[![License](https://poser.pugx.org/tomatophp/filament-api/license.svg)](https://packagist.org/packages/tomatophp/filament-api)
[![Downloads](https://poser.pugx.org/tomatophp/filament-api/d/total.svg)](https://packagist.org/packages/tomatophp/filament-api)

Generate APIs from your filament resource using single line of code

## Installation

make sure that you have SQLite3 Driver installed on your PHP config, because this package required it for caching.

```bash
composer require tomatophp/filament-api
```

if you want to use API Resource to list your generated APIs you can register the plugin on `/app/Providers/Filament/AdminPanelProvider.php`

```php
->plugin(\TomatoPHP\FilamentApi\FilamentAPIPlugin::make())
```

## Screenshots

![APIs Resource](https://raw.githubusercontent.com/tomatophp/filament-api/master/arts/api-resource.png)

## Usage

you can generate API by add this trait to your resource pages

```php
use TomatoPHP\FilamentApi\Traits\InteractWithAPI;
use \Filament\Resources\Pages\ListRecords;

class ListPosts extends ListRecords
{
    use InteractWithAPI;
}
```

and that's it you can now access your API by `/api/{slug}`

we provide 5 methods:

- GET `/api/{slug}` to list all records `support searching by use search=`
- GET `/api/{slug}/{id}` to get single record
- POST `/api/{slug}` to create new record
- PUT `/api/{slug}/{id}` to update record
- DELETE `/api/{slug}/{id}` to delete record

## Custom your API

you can customize your api by override this methods

```php
// Use to return API JSON Resource on Index/Show/Store/Update
public static function getFilamentAPIResource(): ?string
{
    return null;
}

// Use To Custom Your Route Middleware
public static function getFilamentAPIMiddleware(): array
{
    return config('filament-api.default_middleware');
}

// Use To Change the Endpoint Slug
public static function getFilamentAPISlug(): ?string
{
    return null;
}
```

## Publish Assets

you can publish config file by use this command

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

## Other Filament Packages

checkout our [Awesome TomatoPHP](https://github.com/tomatophp/awesome)