README

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Installation

You can install the package via composer:

composer require porifa/jarason

You can publish the config file with:

php artisan vendor:publish --tag="jarason-config"

This is the contents of the published config file:

return [

    /*
    |--------------------------------------------------------------------------
    | Request Headers
    |--------------------------------------------------------------------------
    |
    | Headers should be an array of headers sent with API request.
    |
    */
    'headers' => [
        'accept' => 'application/vnd.api+json',
    ],

    /*
    |--------------------------------------------------------------------------
    | Base Path
    |--------------------------------------------------------------------------
    |
    | The base path of API end-point
    |
    */
    'base_path' => env('JARASON_BASE_PATH', 'http://localhost/api'),

    /*
    |--------------------------------------------------------------------------
    | Version of API
    |--------------------------------------------------------------------------
    |
    | This is version of API which is used after base path
    |
    */
    'version' => env('JARASON_VERSION', 'v1'),

];

Usage

Use Jarason Generator Command

php artisan make:jarason Post

And it will generate a Post.php in /Jarason directory of your project's base directory, if app is the base directory then You'll find a app/Jarason/Post.php

Now You can use Post Jarason Similar to the Model.

$id = 1;
$post = Post::one($id);
$post->column_name

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

porifa / jarason

Maintainers

Details