jenky/laravel-api

Laravel API

Laravel API

, _(*1)

The package provides a nice and easy way to define API routes and format JSON error response., _(*2)

• Laravel API
  • Install
  • Installation
  • Configuration
  • Usage
  • Error response
  • Change log
  • Testing
  • Contributing
  • Security
  • Credits
  • License

Install

Installation

You may use Composer to install this package into your Laravel project:, _(*3)

``` bash $ composer require jenky/laravel-api, <sub>(*4)</sub>

After installing, publish its assets using the `vendor:publish` Artisan command.

``` bash
php artisan vendor:publish

or, <sub>(*5)</sub>

``` bash php artisan vendor:publish --provider="Jenky\LaravelAPI\ApiServiceProvider", <sub>(*6)</sub>

## Configuration

After publishing Laravel API's assets, its primary configuration file will be located at `config/api.php`. This configuration file allows you to configure your api route and error response format and each configuration option includes a description of its purpose, so be sure to thoroughly explore this file.

> For Header versioning, if the request doesn't have the `Accept` header with correct format then default version from config will be used.

## Usage

### Error response

Dealing with errors when building an API can be a pain. Instead of manually building error responses you can simply throw an exception and the API will handle the response for you. Just add the trait `ExceptionResponse` to your `app/Exceptions/Handler` and the package will automatically catches the thrown exception and will convert it into its JSON representation.

``` php
<?php

namespace App\Exceptions;

use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
use Jenky\LaravelAPI\Exception\ExceptionResponse;

class Handler extends ExceptionHandler
{
    use ExceptionResponse;
}

You can change the default error response format in config/api.php file., <sub>(*7)</sub>

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*8)</sub>

Testing

bash $ composer test, <sub>(*9)</sub>

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details., <sub>(*10)</sub>

Security

If you discover any security related issues, please email contact@lynh.me instead of using the issue tracker., <sub>(*11)</sub>

Credits

• Lynh
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*12)</sub>