PHPackages                             moaalaa/laravel-api-responder - 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. moaalaa/laravel-api-responder

ActiveLibrary[API Development](/categories/api)

moaalaa/laravel-api-responder
=============================

A Package For Easy And Structured Api Response

v1.4.1(1y ago)377903[1 issues](https://github.com/moaalaa/laravel-api-responder/issues)MITPHPPHP ^7.1|^8

Since Mar 27Pushed 1y ago1 watchersCompare

[ Source](https://github.com/moaalaa/laravel-api-responder)[ Packagist](https://packagist.org/packages/moaalaa/laravel-api-responder)[ Docs](https://github.com/moaalaa/laravel-api-responder)[ RSS](/packages/moaalaa-laravel-api-responder/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (9)Dependencies (1)Versions (9)Used By (0)

Api Laravel Responder
=====================

[](#api-laravel-responder)

Api Responder Is A Simple Package For Api Response Using Laravel Resources With Some Features With Some Useful Readable And Chainable Methods

> **This Package Was Made For My Personal Usage**

- [Prerequisite](#Prerequisite)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
    - [Basic Usage](#basic-usage)
    - [Response Usage](#response-usage)
        - [Response Alias](#response-alias)
    - [Get Paginate Limit Usage](#get-paginate-limit-usage)
    - [Set Paginate Limit Usage](#set-paginate-limit-usage)
    - [Error Usage](#error-usage)
    - [Safe Error Usage](#safe-error-usage)
    - [Validate Usage](#validate-usage)
    - [With Usage](#with-usage)
    - [Get Wrapping Usage](#get-wrapping-usage)
    - [Set Wrapping Usage](#set-wrapping-usage)
- [Example](#example)
- [Todo](#todo)

Prerequisites
-------------

[](#prerequisites)

> This Package Required Laravel 5.5 (or higher)

Getting Started
---------------

[](#getting-started)

Remember This Package Not Perfect It's Just Like Some Helpers For Me During Development. You Can Visit [Laravel Official Docs](https://laravel.com/docs/master/eloquent-resource) About Api Resources For Deeper Understanding All The Rest Of The Documentation Will Explain How To Install And Every Method Provided To You

Installation
------------

[](#installation)

Via Composer

```
$ composer require moaalaa/laravel-api-responder
```

If You Do Not Run Laravel 5.5 (Or Higher), Then Add The Service Provider In **`config/app.php`**:

```
MoaAlaa\ApiResponder\ApiResponderServiceProvider::class,
```

If you do run the package on Laravel 5.5+, [package auto-discovery](https://medium.com/@taylorotwell/package-auto-discovery-in-laravel-5-5-ea9e3ab20518) takes care of the magic of adding the service provider.

Usage
-----

[](#usage)

Using ApiResponder is Very Easy And Straights Forward Just Use **`ApiResponder` Trait** Anywhere (I Usually Use It In Controllers So The Usage And Examples Will Be Also).

```