webkenth/directus-api-laravel

Directus API Wrapper for Laravel 9, credit to C14r/directus-api-laravel

v1.2 2022-08-02 07:52 UTC

Requires

• php: ^7.3|^7.4|^8.0|^8.1
• webkenth/directus-api: ^1.2

GPL-3.0-only

• Christian Pfeifer
• Martin Knudsen

README

This package allows users to easily consume the REST API provided by the Directus Headless CMS system in any Laravel app.

If your looking for an API Wrapper without using Laravel, see c14r/directus-api.

Installing

The recommended way to install Directus-API is through Composer.

composer require c14r/directus-api-laravel

In Laravel 5, update the config/app.php providers array with the Service Provider:

C14r\Directus\Laravel\DirectusServiceProvider::class,

Configuration

By default, the package is set up to use the following configuration values from your .env file:

• DIRECTUS_URL - The base URL of your Directus instance.
• DIRECTUS_PROJECT - The Directus project, you want to use

Authentification

You can enter

• DIRECTUS_API_KEY - The key generated by Directus and associated with a user

or

• DIRECTUS_USERNAME - The Directus username
• DIRECTUS_PASSWORD - The password for you Directus user

If you enter non of them, the guest access is used.

Laravel

If you would like to use a config file, you can publish the default config by running the following command:

php artisan vendor:publish --provider="C14r\Directus\Laravel\DirectusServiceProvider"

This will publish a config file to config/directus.php.

Usage

To utilize the API Wrapper, use dependency injection to resolve:

public function __construct(Directus $directus)
{
    $this->api = $directus;
}

or use the helper function:

directus() // or directus('connection')

How the API works

Take a look at c14r/directus-api for more details.