Skip to content

I created this package to make it easier to format the response from a controller. I have used this package in my projects and I hope you enjoy it!

Notifications You must be signed in to change notification settings

antare74/response-formatter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project logo

Laravel Response Formatter

Status GitHub Issues GitHub Pull Requests License


I created this package to make it easier to format the response from a controller. I have used this package in my projects and I hope you enjoy it!


📝 Table of Contents

🧐 About

It is a simple package that allows you to format your response in a consistent way. This might be useful for your API, or for your front-end.

🏁 Getting Started

These instructions will help you get started with your project.

Prerequisites

What things you need to install the software and how to install them.

composer
Laravel Version: >= 5.8

Installing

A step by step series of examples that tell you how to get a development env running.

composer require antare74/response-formatter

🎈 Usage

Example Usage.

<?php

use Illuminate\Support\Facades\Route;
use Antare74\ResponseFormatter\Format;

/*
|--------------------------------------------------------------------------
| Web Routes
|--------------------------------------------------------------------------
|
| Here is where you can register web routes for your application. These
| routes are loaded by the RouteServiceProvider within a group which
| contains the "web" middleware group. Now create something great!
|
*/

Route::get('/success', function () {
    return Format::success([
        'name' => 'Antare74',
        'age' => '74',
        'address' => 'Jakarta',
    ], 'Success Message');
});

Route::get('/error', function () {
    return Format::error([
        'my_error_data' => 'Error Message',
    ], 'Error Message', 500);
});

Example Success Response.

{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Success Message",
    "is_paginated": false
  },
  "pagination": [
    
  ],
  "data": {
    "name": "Antare74",
    "age": "74",
    "address": "Jakarta"
  }
}

Example Error Response.

{
  "meta": {
    "code": 500,
    "status": "error",
    "message": "Error Message",
    "is_paginated": false
  },
  "data": {
    "my_error_data": "Error Message"
  }
}

✍️ Authors

See also the list of contributors who participated in this project.

🎉 Acknowledgements

About

I created this package to make it easier to format the response from a controller. I have used this package in my projects and I hope you enjoy it!

Topics

Resources

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Languages