cerbero/json-api-error
最新稳定版本:0.5.0
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.
统计信息
- 总下载量: 5.17k
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 2
- 点击次数: 1
- 依赖项目数: 0
- 推荐数: 0
其他信息
- 授权协议: MIT
- 更新时间: 2024-02-29