Giter VIP home page Giter VIP logo

json-api-error's Introduction

JSON:API error response

Spec

https://jsonapi.org/examples/#error-objects-basics

Installation

composer require sinema/json-api-error

Usage

Basic Usage

<?php

use Sinemah\JsonApi\Error\Error;
use Sinemah\JsonApi\Error\ErrorBag;

$errors = new ErrorBag();

$errors->add(
    Error::fromArray(
        [
            'status' => 404,
            'source' => null,
            'title' => 'Item not found',
            'detail' => sprintf('Item %s not found', 'some-id'),
        ]
    )
);

$errors->toArray()

Result as JSON representation

[
  {
    "status": 404,
    "title": "Item not found",
    "detail": "Item some-id not found"
  }
]

Response Usage

<?php

use Sinemah\JsonApi\Error\Error;
use Sinemah\JsonApi\Error\Response;

$response = Response::get();

$response->add(
    Error::fromArray(
        [
            'status' => 404,
            'source' => null,
            'title' => 'Item not found',
            'detail' => sprintf('Item %s not found', 'some-id'),
        ]
    )
);

$response->toArray()

Result as JSON representation

{
    "errors": [
        {
            "status": 404,
            "title": "Item not found",
            "detail": "Item some-id not found"
        }
    ]
}

json-api-error's People

Contributors

falki141 avatar sinemah avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

falki141

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.