programic/laravel-kenniss

Laravel extension for KENNISS API

v1.0.2 2024-08-20 14:58 UTC

Requires

• php: ^8.2
• laravel/framework: ^10.0

Requires (Dev)

• orchestra/testbench: ^8.0
• programic/pro-backend-quality: ^3.0

proprietary

• Programic

• laravel
• programic
• KENNISS

README

A Laravel API wrapper for KENNISS API

Installation

This package requires PHP 8.2 and Laravel 10 or higher.

composer require programic/laravel-kenniss

Add KENNISS credentials to your services config and .env:

'kenniss' => [
    'baseUrl' => env('KENNISS_BASE_URL'),
    'apiKey' => env('KENNISS_API_TOKEN'),
],

Usage

Retrieve client

Get client from IoC

$kenniss = app(Programic\Kenniss\Kenniss::class);

By Dependency Injecten

use Programic\Kenniss\Kenniss;

class UserController extends Controller {
    public function __invoke(Kenniss $client)
    {
        //
    }
}

Using client

Default requests

$kenniss->get('/users');
$kenniss->post('/users', []);
$kenniss->patch('/users/1', []);
$kenniss->delete('/users/1', []);

Reference requests

$user = $kenniss->users()->find(1);
$user = $kenniss->users()->create([]);
$user = $kenniss->users()->update(1, []);
$user = $kenniss->users()->delete(1);

There are more references available. The IDE will autocomplete the available references.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security-related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Rick Bongers
• All Contributors

License

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