README

A lightweight PHP library for standardizing API success and error response payloads.

Installation

composer require moassaad/api-resource

Usage

<?php

use ApiResource\App\API\APIResource;

$api = APIResource::new();

$success = $api->successOk('Request completed', ['id' => 1]);
// [
//   'status' => 200,
//   'message' => 'Request completed',
//   'data' => ['id' => 1],
//   'errors' => []
// ]

$error = $api->errorNotFound('User not found');
// [
//   'status' => 404,
//   'message' => 'User not found',
//   'data' => null,
//   'errors' => ['Not Found.']
// ]

Available helpers

Success responses

• success($status, $message = "", $data = null)
• successOk($message = "", $data = null)
• successCreated($message = "", $data = null)
• successNoContent($message = "", $data = null)
• successNotModified($message = "", $data = null)

Error responses

• error($status, $message, $errors)
• errorBadRequest($message, $errors = ['Bad Request.'])
• errorUnauthorized($message, $errors = ['Unauthorized.'])
• errorForbidden($message, $errors = ['Forbidden.'])
• errorNotFound($message, $errors = ['Not Found.'])
• errorConflict($message, $errors = ['Conflict.'])
• errorInternalServerError($message, $errors = ['Internal Server Error.'])

Version

Current release: v1.0.1