Download the PHP package tyloo/api-response-helpers without Composer
On this page you can find all versions of the php package tyloo/api-response-helpers. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tyloo/api-response-helpers
More information about tyloo/api-response-helpers
Files in tyloo/api-response-helpers
Package api-response-helpers
Short Description A super simple package allowing for consistent API responses throughout your application
License MIT
Homepage https://github.com/tyloo/api-response-helpers
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package api-response-helpers
API Response Helpers
A simple package allowing for consistent API responses throughout your PHP application (Symfony, Laravel).
Requirements
- PHP
^8.0
Installation / Usage
composer require tyloo/api-response-helpers
Simply reference the required trait within your controller:
Optionally, the trait could be imported within a base controller.
Available methods
respondNotFound(string|Exception $message, ?string $key = 'error')
Returns a 404 HTTP status code, an exception object can optionally be passed.
respondWithSuccess(?array $contents = [])
Returns a 200 HTTP status code
respondOk(string $message)
Returns a 200 HTTP status code
respondUnAuthenticated(?string $message = null)
Returns a 401 HTTP status code
respondForbidden(?string $message = null)
Returns a 403 HTTP status code
respondError(?string $message = null)
Returns a 400 HTTP status code
respondCreated(?array $data = [])
Returns a 201 HTTP status code, with response optional data
respondNoContent(?array $data = [])
Returns a 204 HTTP status code, with optional response data. Strictly speaking, the response body should be empty. However, functionality to optionally return data was added to handle legacy projects. Within your own projects, you can simply call the method, omitting parameters, to generate a correct 204 response i.e. return $this->respondNoContent()
Use with additional object types
In addition to a plain PHP array, the following data types can be passed to relevant methods:
- Objects implementing the native PHP
JsonSerializablecontract
This allows a variety of object types to be passed and converted automatically.
Below are a few common object types that can be passed.
Motivation
Ensure consistent JSON API responses throughout an application. The motivation was primarily based on a very old inherited project. The project contained a plethora of methods/structures used to return an error:
return new JsonResponse(['error' => $error], 400)return new JsonResponse(['data' => ['error' => $error], 400)return new JsonResponse(['message' => $error], Response::HTTP_BAD_REQUEST)return new JsonResponse([$error], 400)- etc.
I wanted to add a simple trait that kept this consistent, in this case:
$this->respondError('Ouch')
Contribution
Any ideas are welcome. Feel free to submit any issues or pull requests.
Testing
vendor/bin/phpunit
Credits
- Julien Bonvarlet
- Heavily inspired by Rob Allport
License
The MIT License (MIT). Please see License File for more information.
