Download the PHP package okriiza/laravel-api-response-formatter without Composer
On this page you can find all versions of the php package okriiza/laravel-api-response-formatter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download okriiza/laravel-api-response-formatter
More information about okriiza/laravel-api-response-formatter
Files in okriiza/laravel-api-response-formatter
Package laravel-api-response-formatter
Short Description a simple package Format API responses throughout your Laravel application
License MIT
Homepage https://github.com/okriiza/laravel-api-response-formatter
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 laravel-api-response-formatter
Laravel API Response Formatter
Laravel API Response Formatter is a class that provides methods for formatting API responses in a standardized format. It simplifies the process of creating consistent and well-structured JSON responses in your API.
Requirements
- PHP
^7.4 | ^8.0 - Laravel 6, 7, 8, 9 or 10
Installation
You can install the package via composer:
The package will automatically register itself.
Function List
The Laravel API Response Formatter class provides the following functions:
| Function | Description |
|---|---|
success() |
Formats a success response with optional data, message, status, and HTTP code. |
created() |
Formats a created response with optional data, message, status, and HTTP code. |
noContent() |
Formats a no content response with optional data, message, status, and HTTP code. |
error() |
Formats an error response with optional data, message, status, and HTTP code. |
unAuthenticated() |
Formats an unauthenticated response with optional data, message, status, and HTTP code. |
forbidden() |
Formats a forbidden response with optional data, message, status, and HTTP code. |
notFound() |
Formats a not found response with optional data, message, status, and HTTP code. |
methodNotAllowed() |
Formats a method not allowed response with optional data, message, status, and HTTP code. |
failedValidation() |
Formats a failed validation response with optional data, message, status, and HTTP code. |
Parameters
The functions in the Laravel API Response Formatter class accept the following parameters:
$data(optional): The data to be included in the response. It can be of any type.$message(optional): The message to be included in the response. If not provided, a default message will be used.$status(optional): The success status of the response. Defaults totruefor success responses andfalsefor error responses.$httpCode(optional): The HTTP response code to be returned. It defaults to the corresponding HTTP status code for each response type.
Example Usage
Here's an example of how you can use the Laravel API Response Formatter class in a user controller:
In the above example, the show() method fetches a user by ID and returns a success response if the user exists. If the user is not found, it returns a not found response. The create() method performs validation and creates a new user. If the validation fails, it returns a failed validation response. Otherwise, it returns a created response with the created user.
And for an error case:
The meta object contains information about the response, such as the response code, status, and message. The result object holds the actual response data.
Note: The examples provided are simplified and may require modifications to fit your specific use case
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
This package was created by Rendi Okriza
- All Contributors
License
The Laravel API Response Formatter package is open-sourced software licensed under the MIT license.
