cerbero/json-api-error

Laravel 包,用于根据 JSON:API 规范标准化 API 错误。

0.4.4 2024-05-31 05:24 UTC

This package is auto-updated.

Last update: 2024-08-31 00:37:28 UTC


README

Author PHP Version Laravel Version Build Status Coverage Status Quality Score PHPStan Level Latest Version Software License PER Total Downloads

{
  "errors": [
    {
      "status": "422",
      "title": "Unprocessable Content",
      "detail": "The name field must be a string.",
      "source": {
        "pointer": "/name"
      }
    },
    {
      "status": "422",
      "title": "Unprocessable Content",
      "detail": "The name field must be at least 2 characters.",
      "source": {
        "pointer": "/name"
      }
    }
  ]
}

Laravel 包,用于根据 JSON:API 规范 标准化 API 错误响应,提供

  • 一致性:确保所有 Laravel 应用中的 API 错误响应统一,遵循广泛使用的标准
  • 自动化:自动处理 Laravel 特定和常见的 HTTP 异常
  • 简单性:仅关注错误响应,无需实现完整的 JSON:API 规范
  • 零配置:无需额外配置即可安装包
  • 自定义:可选注册自定义处理器,将错误映射到 HTTP 状态或合并默认数据
  • 本地化:将 JSON:API 错误翻译成任何语言
  • 可测试性:使用内置的测试工具测试错误响应
  • 调试:检查原始消息并在发生意外错误时进行跟踪

📦 安装

通过 Composer

composer require cerbero/json-api-error

🔮 使用方法

注意

工作正在进行中... 🏗️

  • 实现 链接
  • 编写文档
  • 达到 100% 代码覆盖率
  • 标记稳定版本

📆 变更日志

请参阅 CHANGELOG 了解最近更改的详细信息。

🧪 测试

composer test

💖 贡献

请参阅 CONTRIBUTINGCODE_OF_CONDUCT 了解详细信息。

🧯 安全

如果您发现任何与安全相关的问题,请通过电子邮件 andrea.marco.sartori@gmail.com 联系,而不是使用问题跟踪器。

🏅 致谢

⚖️ 许可证

MIT 许可证 (MIT)。有关更多信息,请参阅 许可证文件