mlk9/dual-response

With this package, you can operate your API and web in a single controller. (Laravel 6>=)

v1.0.3 2022-08-02 17:03 UTC

This package is auto-updated.

Last update: 2024-09-28 21:21:15 UTC


README

Dual Response

With this package, you can operate your API and web in a single controller. (Laravel 6>=)

با این پکیج می توانید پاسخ های متفاوتی هنگامی که در روت api یا web می فرستید دریافت کنید.

Installation via composer

$ composer require mlk9/dual-response

then publish vendor

$ php artisan vendor:publish --tag=dual-response

Documents

Example for usage

response($webRoute //your response, $apiRoute //your json response)

BookController.php

use Mlk9\DualResponse\Facades\DualRes; 
...


/**
 * Display a listing of the resource.
 *
 * @return \Illuminate\Http\Response
 */
public function index()
{
  $books = Book::paginate(40);
  return DualRes::response(view('book.index',compact('books')),['data' => $books]);
}

You can change default values with pass array

Default Response Api

'status_result' => true,
'status_code' => 200,
'message' => __('dualres.request_successful'),
'errors' => null, //removes when don't have any errors
'data' => null, //removes when don't have any data
'current_time' => now()->timestamp,

Default Response When you pass to key error

In api routes :

'status_result' => false,
'status_code' => 400,
'message' => __('dualres.request_not_valid'),
'errors' => [//your errors],
'current_time' => now()->timestamp,

In web routes return your response.

Default Response When you pass to key data

In api routes :

'status_result' => true,
'status_code' => 200,
'message' => __('dualres.request_successful'),
'data' => [//your data],
'current_time' => now()->timestamp,

In web routes return your response.

Default Response When you pass null to key data (not found - 404)

In api routes :

'status_result' => false,
'status_code' => 404,
'message' => __('dualres.not_found'),
'current_time' => now()->timestamp,

In web routes abort 404 error.