tembra/

jsonapi-errors-php

JSON API Errors兼容格式的PHP实现。

维护者

详细信息

github.com/tembra/jsonapi-errors-php

主页

源代码

问题

安装: 973

依赖: 0

建议者: 0

安全: 0

星级: 6

关注者: 1

分支: 0

开放问题: 1

v0.8.0 2016-06-30 18:35 UTC

Requires

Suggests

  • dingo/api: A RESTful API package for the Laravel and Lumen frameworks.

BSD-3-Clause f38ad22dc69e1dffbd8e1930a829b6590551ff39

jsonerrorsapierrorjson apiJSON-API

This package is not auto-updated.

Last update: 2024-09-14 19:36:42 UTC

README

License Version Total Installs StyleCI

描述

JSON API logo

本框架无关的包实现了一种简单高效的方式，在JSON API规范版本v1.0中抛出或响应错误，如JSON API Errors中所述。它还帮助创建应用程序中这些错误的文档。它基于第三方包neomerx/json-api，该包完全实现了JSON API Format。

它极大地简化了错误处理，同时保证了代码质量。

仍然框架无关，您可以轻松地将它与Laravel/Lumen和Dingo API集成。

达到v1.0里程碑

  • 将JSON API错误简化为调用函数
  • 标准化错误
  • 为HTTP状态码提供最常用的错误函数
  • 抛出异常或返回JSON字符串
  • 重写JSON API错误对象的成员
  • 支持本地化
  • 为应用程序错误代码生成文档
  • 构建PHPUnit测试

示例用法

假设您不希望特定的类标准化错误，并且不想使用文档或本地化，您可以使用以下简单的代码

echo MyJsonApiErrors::badRequest([
  827 => [
    'title' => 'Another Error',
    'detail' => 'Detailed error description'
  ]
], false);

将输出字符串

{
  "errors": [
    {
      "status": "400",
      "code": "827",
      "title": "Another Error",
      "detail": "Detailed error description"
    }
  ]
}

第一个参数是一个关联数组，其中key是符合JSON API格式的错误code，而value是另一个关联数组，其中key/value对是JSON API错误对象可能拥有的其他成员。

第二个参数false用于定义是否应该抛出JsonApiException或仅返回JSON字符串。

对于更高级的用法，请参阅Wiki.

有问题吗？

请随时通过tdt@mytdt.com.br联系我或在问题中发表意见。

许可证

BSD 3-Clause。请参阅许可证文件以获取更多信息。