cerbero/json-api-error
Composer 安装命令:
composer require cerbero/json-api-error
包简介
Laravel package to standardize API errors in compliance with the JSON:API spec.
README 文档
README
{
"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 package to standardize API error responses in compliance with the JSON:API spec, providing:
- consistency: ensure uniform API error responses across all Laravel apps, adhering to a widely used standard
- automation: handle Laravel-specific and common HTTP exceptions automatically
- simplicity: focus solely on error responses without the need to implement the full JSON:API spec
- zero configuration: install the package with no additional configuration required
- customization: optionally register custom handlers, map errors to HTTP statuses or merge default data
- localization: translate JSON:API errors into any language
- testability: test error responses using the built-in testing tools
- debugging: inspect the original message and trace when an unexpected error occurs
📦 Install
Via Composer:
composer require cerbero/json-api-error
🔮 Usage
Note
Work in progress... 🏗️
- implement
links - write documentation
- reach 100% code coverage
- tag stable version
📆 Change log
Please see CHANGELOG for more information on what has changed recently.
🧪 Testing
composer test
💞 Contributing
Please see CONTRIBUTING and CODE_OF_CONDUCT for details.
🧯 Security
If you discover any security related issues, please email andrea.marco.sartori@gmail.com instead of using the issue tracker.
🏅 Credits
⚖️ License
The MIT License (MIT). Please see License File for more information.
cerbero/json-api-error 适用场景与选型建议
cerbero/json-api-error 是一款 基于 PHP 开发的 Composer 扩展包,目前已累计 5.23k 次下载、GitHub Stars 达 2, 最近一次更新时间为 2024 年 02 月 29 日, 在 PHP 生态内属于活跃度较高的组件。
它主要适用于以下技术方向: 「json」 「errors」 「api」 「laravel」 「error-handling」 「JSON-API」 等业务场景。在实际项目中,围绕这些方向常见需要落地的问题包括:接口对接、性能调优、并发安全、与既有框架(Laravel / ThinkPHP / Yii / Webman 等)的兼容适配,以及生产环境的日志埋点与稳定性保障。
我们在过去多个企业项目中使用过 cerbero/json-api-error 或与其功能相近的方案,如果你在选型或落地过程中遇到问题,例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查,欢迎联系我们协助评估。
基于 cerbero/json-api-error 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复;针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维;也可按月提供技术保姆服务。
与 cerbero/json-api-error 相关的其它包
同方向 / 同关键字的高下载量 PHP Composer 包推荐,方便对比选型:
Kinikit - PHP Application development framework MVC component
ext-json wrapper with sane defaults
Bootstraps errors and handles them via reporters and renderers
A package to cast json fields, each sub-keys is castable
A PSR-7 compatible library for making CRUD API endpoints
Asynchronous Sentry for Symfony - Fire and forget
统计信息
- 总下载量: 5.23k
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 2
- 点击次数: 24
- 依赖项目数: 0
- 推荐数: 0
其他信息
- 授权协议: MIT
- 更新时间: 2024-02-29