README

Filament CMS Builder APIs

Read-only JSON API for TomatoPHP Filament CMS posts and categories.

Requirements

Installation

composer require tomatophp/filament-cms-api

The routes are registered automatically. Registering the plugin on a panel is optional:

->plugin(\TomatoPHP\FilamentCmsApi\FilamentCmsApiPlugin::make())

Endpoints

All endpoints are GET, return API resources and live under the api/cms prefix.

Only posts with is_published and a publish date in the past are returned. Translatable fields use the app locale; add ?locale=ar to switch it per request.

Configuration

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

return [
    'active' => true,              // register the routes
    'prefix' => 'api/cms',
    'middleware' => ['api'],       // add 'auth:sanctum' to make the API private
    'per_page' => 15,
    'max_per_page' => 100,
    'models' => [
        'post' => \TomatoPHP\FilamentCms\Models\Post::class,
        'category' => \TomatoPHP\FilamentCms\Models\Category::class,
    ],
    'resources' => [
        'post' => \TomatoPHP\FilamentCmsApi\Transformers\PostResource::class,
        'category' => \TomatoPHP\FilamentCmsApi\Transformers\CategoryResource::class,
    ],
];

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Security

Please see SECURITY for more information about security.

Credits

• Fady Mondy

License

The MIT License (MIT). Please see License File for more information.