Download the PHP package jenky/laravel-api without Composer
On this page you can find all versions of the php package jenky/laravel-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jenky/laravel-api
More information about jenky/laravel-api
Files in jenky/laravel-api
Package laravel-api
Short Description Laravel API
License MIT
Homepage https://github.com/jenky/laravel-api
Informations about the package laravel-api
Laravel API
The package provides a nice and easy way to define API routes and format JSON error response.
- 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:
After installing, publish its assets using the vendor:publish
Artisan command.
or
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.
You can change the default error response format in
config/api.php
file.
Change log
Please see CHANGELOG for more information on what has changed recently.
Testing
Contributing
Please see CODE_OF_CONDUCT for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Lynh
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-api with dependencies
illuminate/contracts Version ^7.0|^8.0
illuminate/config Version ^7.0|^8.0
illuminate/support Version ^7.0|^8.0