usermp/artisan-api

artisan-api is a Laravel package that allows you to execute Artisan commands via an API route

v1.0.3 2024-10-16 12:02 UTC

Requires

• php: ^8.2
• laravel/framework: ^11.0
• sentry/sentry-laravel: *

MIT

• mohammad

README

artisan-api is a Laravel package that allows you to execute Artisan commands via an API route. This package simplifies the process of managing your Laravel application's Artisan commands by providing a straightforward and easy-to-use API interface.

Installation

To install the artisan-api package, you can use Composer. Run the following command in your terminal:

composer require usermp/artisan-api

After installing the package, you need to register the ArtisanServiceProvider in your Laravel application. To do this, add the service provider to the providers array in your bootstrap/providers.php file:

return [
    ...
     Usermp\ArtisanApi\ArtisanServiceProvider::class,
],

Next, publish the configuration file to customize the package's settings. Run the following command:

php artisan vendor:publish --provider="Usermp\ArtisanApi\ArtisanServiceProvider" --tag="artisan-api-config"

This will create a configuration file at config/artisanapi.php.

Configuration

The configuration file allows you to customize the behavior of the artisan-api package. Below is the default configuration:

return [
    'with_key' => env('ARTISAN_WITH_KEY', false),
    'api_key'  => env('ARTISAN_API_KEY', 'YOUR KEY'),
    'allowed_commands' => [
        // General commands
        'list',
        'help',

        // Make commands
        'make:controller',
        'make:model',
        'make:migration',
        'make:seeder',
        'make:factory',
        'make:middleware',
        'make:request',
        'make:resource',
        'make:command',
        'make:event',
        'make:listener',
        'make:policy',
        'make:provider',
        'make:test',
        'make:job',
        'make:rule',
        'make:mail',
        'make:notification',

        // Migrations
        'migrate',
        'migrate:rollback',
        'migrate:refresh',
        'migrate:reset',
        'migrate:status',

        // Seeder
        'db:seed',
        'db:wipe',

        // Cache
        'cache:clear',
        'cache:forget',
        'config:clear',
        'config:cache',
        'route:cache',
        'route:clear',
        'view:cache',
        'view:clear',

        // Queue
        'queue:work',
        'queue:listen',
        'queue:restart',
        'queue:table',
        'queue:flush',

        // Maintenance
        'down',
        'up',

        // Others
        'optimize',
        'serve',
        'schedule:run',
        'schedule:work',

        // Add other commands as needed
    ],
];

• with_key: Determines if an API key is required to execute commands. Default is false.
• api_key: The API key used for authentication when with_key is set to true
• allowed_commands: An array of allowed Artisan commands that can be executed via the API.

Usage

Running Artisan Commands via API You can run any Artisan command using the api/artisan route. The request should be a POST request and include the command and its arguments in the request body.

Example Request

POST /api/artisan
Content-Type: application/json
{
  "command": "migrate:fresh --seed",
}