Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/treblle/error-codes
Treblle Error Codes is a PHP package that makes it easy to provide consistent error codes in your applications. With this package, you can easily determine the appropriate error code for any situation, and then access the associated attributes for that code
https://github.com/treblle/error-codes
backend error-monitoring monitoring package php
Last synced: about 1 month ago
JSON representation
Treblle Error Codes is a PHP package that makes it easy to provide consistent error codes in your applications. With this package, you can easily determine the appropriate error code for any situation, and then access the associated attributes for that code
- Host: GitHub
- URL: https://github.com/treblle/error-codes
- Owner: Treblle
- License: mit
- Created: 2023-08-25T10:17:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-13T14:16:02.000Z (10 months ago)
- Last Synced: 2024-11-23T09:43:19.614Z (about 1 month ago)
- Topics: backend, error-monitoring, monitoring, package, php
- Language: PHP
- Homepage: https://www.treblle.com/
- Size: 57.6 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# API Error Codes
[![Latest Version][badge-release]][packagist]
[![PHP Version][badge-php]][php]
[![Total Downloads][badge-downloads]][downloads]
[badge-release]: https://img.shields.io/packagist/v/treblle/error-codes.svg?style=flat-square&label=release
[badge-php]: https://img.shields.io/packagist/php-v/treblle/error-codes.svg?style=flat-square
[badge-downloads]: https://img.shields.io/packagist/dt/treblle/error-codes.svg?style=flat-square&colorB=mediumvioletred
[packagist]: https://packagist.org/packages/treblle/error-codes
[php]: https://php.net
[downloads]: https://packagist.org/packages/treblle/error-codes
Integrations
•
Website
•
Docs
•
Blog
•
Twitter
•
Discord
A package to help you provide consistent error codes.
## Installation
```bash
composer require treblle/error-codes
```
## Usage
This package is easy to use, you can determine what Error Code you need. Then access the attributes attached to it.
```php
use Treblle\ErrorCodes\Enums\ErrorCode;
$badRequest = ErrorCode::BAD_REQUEST;
$title = $badRequest->getDescription()->title; // Bad Request
$code = $badRequest->getDescription()->code; // HTTP_400
$link = $badRequest->getDescription()->link; // https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400
$status = $badRequest->getDescription()->status; // 400
```
## Combining
This package works very well with the `treblle/api-responses` package.
```php
final class Handler extends ExceptionHandler
{
public function register(): void
{
$this->renderable(function (ModelNotFoundException $exception, Request $request) {
$errorCode = \Treblle\ErrorCodes\Enums\ErrorCode::NOT_FOUND;
return new ErrorResponse(
data: new ApiError(
title: $errorCode->getDescription()->title,
detail: $exception->getMessage(),
instance: $request->path(),
code: $errorCode->getDescription()->code,
link: $errorCode->getDescription()->link,
),
status: Status::NOT_FOUND,
);
});
}
}
```
## Community 💙
First and foremost: **Star and watch this repository** to stay up-to-date.
Also, follow our [Blog](https://blog.treblle.com), and on [Twitter](https://twitter.com/treblleapi).
You can chat with the team and other members on [Discord](https://treblle.com/chat) and follow our tutorials and other video material at [YouTube](https://youtube.com/@treblle).
[](https://treblle.com/chat)
[](https://youtube.com/@treblle)
[](https://twitter.com/treblleapi)
### How to contribute
Here are some ways of contributing to making Treblle better:
- **[Try out Treblle](https://docs.treblle.com/en/introduction#getting-started)**, and let us know ways to make Treblle better for you. Let us know here on [Discord](https://treblle.com/chat).
- Join our [Discord](https://treblle.com/chat) and connect with other members to share and learn from.
- Send a pull request to any of our [open source repositories](https://github.com/Treblle) on Github. Check the contribution guide on the repo you want to contribute to for more details about how to contribute. We're looking forward to your contribution!
-
## Testing
To run the test suite:
```bash
composer run test
```
## Credits
## LICENSE
The MIT LIcense (MIT). Please see [License File](./LICENSE) for more information.