https://github.com/kolirt/laravel-api-response
⭐️ Unification of API responses for Laravel projects inspired by telegram api responses
https://github.com/kolirt/laravel-api-response
api api-response api-responser json-response laravel rest-api
Last synced: about 1 month ago
JSON representation
⭐️ Unification of API responses for Laravel projects inspired by telegram api responses
- Host: GitHub
- URL: https://github.com/kolirt/laravel-api-response
- Owner: kolirt
- License: mit
- Created: 2019-02-15T06:46:25.000Z (over 6 years ago)
- Default Branch: v3
- Last Pushed: 2024-09-08T09:01:23.000Z (9 months ago)
- Last Synced: 2025-04-17T10:42:08.829Z (about 2 months ago)
- Topics: api, api-response, api-responser, json-response, laravel, rest-api
- Language: PHP
- Homepage:
- Size: 71.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# Laravel Api Response
Unification of API responses for Laravel projects inspired by telegram api responses
## Structure
- [Getting started](#getting-started)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Example](#example)
- [Error response](#error-response)
- [Success response](#success-response)
- [Methods](#methods)
- [error](#error)
- [success](#success)
- [setCode](#setcode)
- [setDescription](#setdescription)
- [setErrors](#seterrors)
- [abort](#abort)
- [cookie](#cookie)
- [setData](#setdata)
- [render](#render)
- [FAQ](#faq)
- [License](#license)
- [Other packages](#other-packages)
## Getting started
### Requirements
- PHP >= 8.1
- Laravel >= 10
For lesser versions of Laravel or PHP, use the [v2](https://github.com/kolirt/laravel-api-response/tree/v2)
### Installation
```bash
composer require kolirt/laravel-api-response
```
## Usage
### Example
#### Error response
```php
return api()
->error()
->setCode(400) // default code 400
->setDescription(['Description #1', 'Description #2'])
// or
->setDescription('Description')
->setData(['Data #1', 'Data #2'])
// or
->setData('Data')
->render();
```
```php
[
'ok' => false,
'error_code' => 400,
'description' => ['Description #1', 'Description #2'],
// or
'description' => 'Description',
'result' => ['Data #1', 'Data #2'],
// or
'result' => 'Data',
]
```
#### Success response
```php
return api()
->success()
->setCode(200) // default code 200
->setDescription(['Description #1', 'Description #2'])
// or
->setDescription('Description #1')
->setData(['Data #1', 'Data #2'])
// or
->setData('Data')
->render();
```
```php
[
'ok' => true,
'description' => ['Description #1', 'Description #2'],
// or
'description' => 'Description',
'result' => ['Data #1', 'Data #2'],
// or
'result' => 'Data',
]
```
### Methods
#### `error`
Mark response as error
```php
return api()->error();
```
#### `success`
Mark response as success
```php
return api()->success();
```
#### `setCode`
Set specific code to response. Available [codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)
```php
return api()->setCode($code);
```
#### `setDescription`
Add description to response
```php
return api()->setDescription(['Description #1', 'Description #2']);
// or
return api()->setDescription('Description');
```
#### `setErrors`
Add errors to response
```php
return api()->setErrors([
'first_name' => 'Error message',
'last_name' => ['Error message 1', 'Error message 2']
]);
```
#### `abort`
Abort response with error
```php
return api()->abort('Error message', 400);
```
#### `cookie`
Add cookie to response
```php
return api()->cookie(cookie('token', 'asdsadsadas', 60 * 3));
```
#### `setData`
Add data to response
```php
return api()->setData(['Data #1', 'Data #2']);
// or
return api()->setData('Data');
```
#### `render`
Render response
```php
return api()->render();
```
## FAQ
Check closed [issues](https://github.com/kolirt/laravel-api-response/issues) to get answers for most asked questions
## License
[MIT](LICENSE.txt)
## Other packages
Check out my other packages on my [GitHub profile](https://github.com/kolirt)