README

A Laravel package providing helper functions for streamlined API development. Simplify response handling and enhance the structure of your APIs.

Installation

Install the package via Composer:

composer require decodeblock/api-utility

Usage

Example

Using the ApiResponder trait for handling JSON responses:

use Illuminate\Http\Response;
use Decodeblock\ApiUtility\Traits\ApiResponder;

class YourController extends Controller
{
    use ApiResponder;

    public function index()
    {
        return $this->successResponse("Hello, API Utility", Response::HTTP_OK, null);
    }
}

The ApiResponder trait provides methods like:

• success($message, $code, $data, $metadata = null): For successful responses.
• error($message, $code, $data, $metadata = null): For error responses.

Testing

Run tests using:

composer test

Changelog

Detailed changes for each release are documented in the CHANGELOG.

Contributing

We welcome contributions! Please see the CONTRIBUTING guide for details.

Credits

• Gabriel Ibenye

License

This package is licensed under the MIT License.