sinema/json-api-error

格式化通用的JSON:API错误

维护者

详细信息

github.com/SineMah/json-api-error

主页

源代码

问题

安装次数: 2,703

依赖者: 1

建议者: 0

安全性: 0

星标: 1

关注者: 1

分支: 1

公开问题: 0

0.8 2024-03-13 13:40 UTC

Requires

  • php: ^8.2.0|^8.3.0

MIT da923c23370d2e53a8908a1bf09c242527318e9a

  • Sinema

json apiError Responses

This package is auto-updated.

Last update: 2024-09-13 15:02:55 UTC

README

规范

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

安装

composer require sinema/json-api-error

用法

基本用法

<?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()

JSON表示形式的结果

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

响应用法

<?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()

JSON表示形式的结果

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