saad/json-response-builder

this package semplifies sending API json response by using a standard and unique response structure

1.4 2020-02-02 23:55 UTC

This package is auto-updated.

Last update: 2020-09-03 01:12:28 UTC


README

68747470733a2f2f6c61726176656c2e636f6d2f6173736574732f696d672f636f6d706f6e656e74732f6c6f676f2d6c61726176656c2e737667

Json Response Builder Package

Build Status 68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f38346437303938313461333230646338356630612f6d61696e7461696e6162696c697479 68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f38346437303938313461333230646338356630612f746573745f636f766572616765 License

Install

	composer require saad/json-response-builder

Change Log

V 1.3.1

add feature to merge meta when adding data

addData(str $key, mix $val, bool $merge_meta)

		
	$builder = new Saad\JsonResponseBuilder\JsonResponseBuilder();
	
	$builder->addData('users', [
		['name' => 'Ahmed Saad'],
		'meta' => [
			'name' => 'iam meta',
		]
	], true); // Note the third argument
	
	
	return $builder->getResponse();
	
	// Output
	
	{
        "success": true,
	
        "meta" : {
            'name' => 'iam meta',
        },
	
        "data": [
            'users': [
            		{"name": "Ahmed Saad"}
            ],
        ],
	
        "message": "Successfully Retrieved"
    }

V 1.3

Add Strict Mode and enabled by default: in strict mode if data or meta are empty it will set it's value to null instead of []

to turn of strickt mode, on constructor pass false to disable strickt mode so that it will return data, and meta as empty array if they are empty

you can set mode on instance by the method strictMode(bool)

Usage

  • Basic Example:

    inside your controller:

     	
     	$builder = new Saad\JsonResponseBuilder\JsonResponseBuilder();
     	
     	$builder->mergeData([
     		['name' => 'Ahmed Saad'],
     		['name' => 'John Doe']
     	]);
     	
     	$builder->addMeta([
     		'pagination' => [
     			'page' => 1,
     			'per_page' => 4,
     		]
     	]);
     	
     	return $builder->getResponse();
     	
  • the above example will output:

     
     	{
     		"success": true,
     		
     		"meta" : {
     			"pagination": {
     				"page": 1,
     				"per_page": 4
     			}
     		},
     		
     		"data": [
     			{"name": "Ahmed Saad"},
     			{"name": "John Doe"}
     		],
     		
     		"message": "Successfully Retrieved"
     	}

Available Methods

addData($key, $value)

Appends to data new member with the given key and value

	$builder->addData('doctors', ['ahmed', 'mohamed', 'saad']);
  $builder->addData('patients', ['patient1', 'patient3', 'patient3']);

	// Output data will be 

  "data": {
  	"doctors": ["ahmed", "mohamed", "saad"],
  	"patients" ["patient1", "patient4", "patient3"]
  },

mergeData($array)

merge given array with data with given array keys as keys, this is usefull when we want to send data as json array insteadof json object with key and value

this method also if the given array has key called 'meta' it will remove that key and add it to response meta

	$builder->mergeData(['ahmed', 'mohamed', 'meta' => ['key' => 'Iam Meta']]);

	// Output will be 

	{
   	"success": true,
   	"meta": {
   		"key": "Iam Meta"
   	},	
  	"data": [
  		"ahmed",
  		"mohamed"
  	],
  	"message": "Successfully Retrieved"
  }
  	 

addMeta($key, $value)

Appends to meta new member with the given key and value

mergeMeta($array)

merge given array with meta

addHeader($header, $value)

add header to response headers

success($response_message = null)

set response success status to true, and set response message if supplied.

setMessage($response_message = null)

set response message if supplied.

error($message = null, $error_code = null)

set response success status to false and set nessage and error code

 $builder->error('Fails!', 2345);

 // Output will be 

 {
  	"success": false,
  	"meta": null,	
 	"data": null,
 	'error': {
 		"message": "Fails!",
 		"code": 2345
 	}
 	"message": "Fails!"
 }

addError($key, mixed $value)

Add key to error array

 $builder->error('Fails!', 2345)
 	->addError('validation', 'validation value');

 // Output will be 

 {
  	"success": false,
  	"meta": null,	
 	"data": null,
 	'error': {
 		"message": "Fails!",
 		"code": 2345,
 		"validation": "validation value"
 	}
 	"message": "Fails!"
 }

setStatusCode(301)

set response status code.

strictMode(bool)

default value true

since V1.3

enable or disable strict mode.

 $builder->getResponse();

 // Strict Mode Enabled, Output will be 

 {
  	"success": false,
  	"meta": null,	
 	"data": null,
 	"message": ""
 }

 $builder->strictMode(false)->getResponse();

 // Strict Mode Disabled, Output will be 

 {
  	"success": false,
  	"meta":[],	
 	"data":[],
 	"message": ""
 }

getResponse($status_code = null)

set response status code if supplied, and return Response Object

License

The Laravel framework is open-sourced software licensed under the MIT license.README.md