如何解决PHPAPI错误响应不规范的问题？crell/api-problem助你构建专业级接口

<code class="bash">composer require crell/api-problem</code>

<pre class="brush:php;toolbar:false;"><?php

use Crell\ApiProblem\ApiProblem;

// 假设用户信用不足
$problem = new ApiProblem(
    "你没有足够的信用额度。", // title: 人类可读的错误摘要
    "http://example.com/probs/out-of-credit" // type: 错误类型的URI，可指向详细文档
);

// 设置规范中定义的其他属性
$problem
  ->setDetail("你当前余额为 30，但此操作需要 50。") // detail: 详细的错误描述
  ->setInstance("http://example.net/account/12345/msgs/abc"); // instance: 特定错误实例的URI

// 你还可以添加任何自定义的扩展属性，它们将直接作为 JSON 对象的键值对出现
$problem['balance'] = 30;
$problem['accounts'] = [
  "http://example.net/account/12345",
  "http://example.net/account/67890"
];

// 将 ApiProblem 对象转换为 JSON 字符串
$json_string = $problem->asJson();

// 输出结果可能类似：
// {
//     "type": "http://example.com/probs/out-of-credit",
//     "title": "你没有足够的信用额度。",
//     "detail": "你当前余额为 30，但此操作需要 50。",
//     "instance": "http://example.net/account/12345/msgs/abc",
//     "balance": 30,
//     "accounts": [
//         "http://example.net/account/12345",
//         "http://example.net/account/67890"
//     ]
// }

// 别忘了设置正确的 HTTP 状态码 (如 403 Forbidden) 和 Content-Type: application/problem+json
header('Content-Type: ' . ApiProblem::CONTENT_TYPE_JSON);
header('HTTP/1.1 403 Forbidden'); // 或者其他合适的 HTTP 状态码
echo $json_string;

<code class="php">$body = json_encode($problem); // 效果与 $problem->asJson() 相同</code>

<pre class="brush:php;toolbar:false;"><?php

use Crell\ApiProblem\ApiProblem;
use Crell\ApiProblem\HttpConverter;
use Laminas\Diactoros\ResponseFactory; // 假设你使用 Laminas Diactoros 作为 PSR-17 工厂

$problem = new ApiProblem("资源未找到", "about:blank");
$problem->setDetail("请求的商品ID不存在。");

// 获取一个 PSR-17 ResponseFactory 实例
$factory = new ResponseFactory();

// 创建 HttpConverter，第二个参数控制是否美化输出 JSON
$converter = new HttpConverter($factory, true);

// 将 ApiProblem 转换为 PSR-7 JSON 响应对象
$response = $converter->toJsonResponse($problem, 404); // 404 是 HTTP 状态码

// $response 现在是一个完整的 PSR-7 ResponseInterface 对象，可以直接返回
// 例如：$emitter->emit($response);

<pre class="brush:php;toolbar:false;"><?php

use Crell\ApiProblem\ApiProblem;

$some_json_string = '{
    "type": "http://example.com/probs/out-of-credit",
    "title": "你没有足够的信用额度。",
    "detail": "你当前余额为 30，但此操作需要 50。",
    "balance": 30
}';

$problem = ApiProblem::fromJson($some_json_string);

echo "错误类型: " . $problem->getType() . "\n"; // 输出: http://example.com/probs/out-of-credit
echo "错误标题: " . $problem->getTitle() . "\n"; // 输出: 你没有足够的信用额度。
echo "详细信息: " . $problem->getDetail() . "\n"; // 输出: 你当前余额为 30，但此操作需要 50。
echo "当前余额: " . $problem['balance'] . "\n"; // 输出: 30