Download the PHP package ellipsesynergie/api-response without Composer
On this page you can find all versions of the php package ellipsesynergie/api-response. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ellipsesynergie/api-response
More information about ellipsesynergie/api-response
Files in ellipsesynergie/api-response
Package api-response
Short Description Simple package to handle response properly in your API
License MIT
Homepage https://github.com/ellipsesynergie/api-response
Informations about the package api-response
api-response
Simple package to handle response properly in your API. This package uses Fractal and is based on Build APIs You Won't Hate book.
Install
Via Composer
Requirements
The following versions of PHP are supported by this version:
>= PHP 8.1
Install in Laravel
Add this following service provider to your config/app.php
file.
Install in Lumen
Because of the request object change (see reference) you can no longer access Request
object properly in Service provider. To be convenient, we have created a middleware to be used for parsing the include
parameter.
Register this service provider to your bootstrap/app.php
file.
Register the global middleware bootstrap/app.php
file.
Install in your favorite framework or vanilla php
This package can be used in any framework or vanilla php. You simply need to extend EllipseSynergie\ApiResponse\AbstractResponse
and implement the withArray()
method in your custom class.
You can take a look at EllipseSynergie\ApiResponse\Laravel\Response::withArray()
for an example.
You will also need to instantiate the response class with a fractal manager instance.
For more options related to the fractal manager, you can take a look at the official Fractal website
Example inside Laravel or Lumen controller
Ouput example
One book
Collection of books
Error
Testing the package
Testing within Laravel
According to the issue #31, we have found some problem when it's time to test the include
query parameter value.
If you want to resolve this issue in your test, you must use the trait EllipseSynergie\ApiResponse\Testing\Laravel\AddTestingSupportForInclude
. To replace the call
method from Illuminate\Foundation\Testing\Concerns\MakesHttpRequests::call
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.