PHPackages                             kolirt/laravel-api-response - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. kolirt/laravel-api-response

ActiveLibrary[API Development](/categories/api)

kolirt/laravel-api-response
===========================

The package will help to generate json answers.

3.0.0(1y ago)2560↓50%MITPHPPHP >=8.1CI failing

Since Jul 27Pushed 1y ago1 watchersCompare

[ Source](https://github.com/kolirt/laravel-api-response)[ Packagist](https://packagist.org/packages/kolirt/laravel-api-response)[ Docs](https://github.com/kolirt/laravel-api-response)[ Fund](https://www.buymeacoffee.com/kolirt)[ RSS](/packages/kolirt-laravel-api-response/feed)WikiDiscussions v3 Synced 2mo ago

READMEChangelog (2)Dependencies (1)Versions (4)Used By (0)

Laravel Api Response
====================

[](#laravel-api-response)

Unification of API responses for Laravel projects inspired by telegram api responses

 [![](https://raw.githubusercontent.com/kolirt/laravel-api-response/v3/cover.png)](https://raw.githubusercontent.com/kolirt/laravel-api-response/v3/cover.png)

Structure
---------

[](#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)

[ ![Buy Me A Coffee](https://camo.githubusercontent.com/a6ebf9f3a5d0689c6d7449b0ea0c4ce75bbff5ef09b38babf991cb7a559f8774/68747470733a2f2f63646e2e6275796d6561636f666665652e636f6d2f627574746f6e732f76322f617269616c2d79656c6c6f772e706e67)](https://www.buymeacoffee.com/kolirt)Getting started
---------------

[](#getting-started)

### Requirements

[](#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

[](#installation)

```
composer require kolirt/laravel-api-response
```

Usage
-----

[](#usage)

### Example

[](#example)

#### Error response

[](#error-response)

```
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();
```

```
[
    'ok' => false,
    'error_code' => 400,

    'description' => ['Description #1', 'Description #2'],
    // or
    'description' => 'Description',

    'result' => ['Data #1', 'Data #2'],
    // or
    'result' => 'Data',
]
```

#### Success response

[](#success-response)

```
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();
```

```
[
    'ok' => true,

    'description' => ['Description #1', 'Description #2'],
    // or
    'description' => 'Description',

    'result' => ['Data #1', 'Data #2'],
    // or
    'result' => 'Data',
]
```

### Methods

[](#methods)

#### `error`

[](#error)

Mark response as error

```
return api()->error();
```

#### `success`

[](#success)

Mark response as success

```
return api()->success();
```

#### `setCode`

[](#setcode)

Set specific code to response. Available [codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)

```
return api()->setCode($code);
```

#### `setDescription`

[](#setdescription)

Add description to response

```
return api()->setDescription(['Description #1', 'Description #2']);
// or
return api()->setDescription('Description');
```

#### `setErrors`

[](#seterrors)

Add errors to response

```
return api()->setErrors([
    'first_name' => 'Error message',
    'last_name' => ['Error message 1', 'Error message 2']
]);
```

#### `abort`

[](#abort)

Abort response with error

```
return api()->abort('Error message', 400);
```

#### `cookie`

[](#cookie)

Add cookie to response

```
return api()->cookie(cookie('token', 'asdsadsadas', 60 * 3));
```

#### `setData`

[](#setdata)

Add data to response

```
return api()->setData(['Data #1', 'Data #2']);
// or
return api()->setData('Data');
```

#### `render`

[](#render)

Render response

```
return api()->render();
```

FAQ
---

[](#faq)

Check closed [issues](https://github.com/kolirt/laravel-api-response/issues) to get answers for most asked questions

License
-------

[](#license)

[MIT](LICENSE.txt)

Other packages
--------------

[](#other-packages)

Check out my other packages on my [GitHub profile](https://github.com/kolirt)

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance35

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~136 days

Total

4

Last Release

610d ago

Major Versions

2.0.3 → 3.0.02024-08-12

v2.x-dev → v3.x-dev2024-09-08

### Community

Maintainers

![](https://www.gravatar.com/avatar/ddc1b7be71292157d6a8722ff732ccb23a079d87a3450838a51bd447f227b50e?d=identicon)[kolirt](/maintainers/kolirt)

---

Top Contributors

[![kolirt](https://avatars.githubusercontent.com/u/11573343?v=4)](https://github.com/kolirt "kolirt (10 commits)")

---

Tags

apiapi-responseapi-responserjson-responselaravelrest-apiapilaravelREST APIjson-response

### Embed Badge

![Health badge](/badges/kolirt-laravel-api-response/health.svg)

```
[![Health](https://phpackages.com/badges/kolirt-laravel-api-response/health.svg)](https://phpackages.com/packages/kolirt-laravel-api-response)
```

###  Alternatives

[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

2.9k34.0M112](/packages/darkaonline-l5-swagger)[knuckleswtf/scribe

Generate API documentation for humans from your Laravel codebase.✍

2.3k12.2M45](/packages/knuckleswtf-scribe)[nickurt/laravel-postcodeapi

Universal PostcodeApi for Laravel 11.x/12.x/13.x

97221.2k](/packages/nickurt-laravel-postcodeapi)[mozex/anthropic-laravel

Anthropic PHP for Laravel is a supercharged PHP API client that allows you to interact with the Anthropic API

71226.4k1](/packages/mozex-anthropic-laravel)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)