Download the PHP package signifly/laravel-api-responder without Composer
On this page you can find all versions of the php package signifly/laravel-api-responder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download signifly/laravel-api-responder
More information about signifly/laravel-api-responder
Files in signifly/laravel-api-responder
Package laravel-api-responder
Short Description API Responses for your Laravel API.
License MIT
Homepage https://github.com/signifly/laravel-api-responder
Informations about the package laravel-api-responder
API Responses for your Laravel API
The signifly/laravel-api-responder
package allows you to easily return API responses in your Laravel app.
Below is a small example of how to use it:
It will automatically resolve resources for the provided data if they exist.
Documentation
To get started follow the installation instructions below.
Installation
You can install the package via composer:
The package will automatically register itself.
You can optionally publish the config file with:
This is the contents of the published config file:
Usage
The responder can be used in several ways.
Using the Facade
Using the Trait
Using the Service Container
Custom response codes
You can set the status code of the response by using the setStatusCode
method on the response from the responder.
Specific resource classes
If you would like to specify a resource class it can be passed as the second parameter to the respond method:
Forcing the usage of API resources
If you want to force the usage of API resources, you have to set the force_resources
option to true
in the config/responder.php
file.
When set to true it will throw a ResourceNotFoundException
if a resource for the associated model could not be found.
Using type suffixes
If you are using type suffixes as naming convention, when creating new resources, then you should set the use_type_suffix
option to true
in the config/responder.php
file.
When set to true it expects your resources to be named like UserResource
instead of just User
.
Testing
Security
If you discover any security issues, please email [email protected] instead of using the issue tracker.
Credits
- Morten Poul Jensen
- All contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-api-responder with dependencies
illuminate/contracts Version ^6.0|^7.0|^8.0|^9.0|^10.0
illuminate/database Version ^6.0|^7.0|^8.0|^9.0|^10.0
illuminate/http Version ^6.0|^7.0|^8.0|^9.0|^10.0
illuminate/support Version ^6.0|^7.0|^8.0|^9.0|^10.0