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

Generate APIs from your filament resource using single line of code
https://github.com/tomatophp/filament-api

api filament-plugin filamentphp generator rest tomatophp

Last synced: 26 days ago
JSON representation

Generate APIs from your filament resource using single line of code

• Host: GitHub
• URL: https://github.com/tomatophp/filament-api
• Owner: tomatophp
• License: mit
• Created: 2024-05-09T11:52:58.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-09-23T15:38:15.000Z (3 months ago)
• Last Synced: 2024-11-28T12:55:01.991Z (about 1 month ago)
• Topics: api, filament-plugin, filamentphp, generator, rest, tomatophp
• Language: PHP
• Homepage: https://tomatophp.com/en/open-source/filament-api
• Size: 2.38 MB
• Stars: 22
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
![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)