Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phpro/api-problem-bundle
RFC7807 Problem details integration for Symfony
https://github.com/phpro/api-problem-bundle
Last synced: 2 months ago
JSON representation
RFC7807 Problem details integration for Symfony
- Host: GitHub
- URL: https://github.com/phpro/api-problem-bundle
- Owner: phpro
- License: mit
- Created: 2018-07-02T19:44:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-23T12:51:23.000Z (11 months ago)
- Last Synced: 2024-04-24T21:00:46.112Z (9 months ago)
- Language: PHP
- Size: 82 KB
- Stars: 21
- Watchers: 6
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- License: LICENSE
Awesome Lists containing this project
README
[](https://packagist.org/packages/phpro/api-problem-bundle/stats)
[](https://packagist.org/packages/phpro/api-problem-bundle)
# Api Problem Bundle
This package provides a [RFC7807](https://tools.ietf.org/html/rfc7807) Problem details exception listener for Symfony.
Internal, this package uses the models provided by [`phpro/api-problem`](https://www.github.com/phpro/api-problem).
When an `ApiProblemException` is triggered, this bundle will return the correct response.
## Installation
```sh
composer require phpro/api-problem-bundle
```
If you are not using `symfony/flex`, you'll have to manually add the bundle to your bundles file:
```php
// config/bundles.php
return [
// ...
Phpro\ApiProblemBundle\ApiProblemBundle::class => ['all' => true],
];
```
## Supported response formats
- application/problem+json
## How it works
```php
use Phpro\ApiProblem\Exception\ApiProblemException;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
class SomeController
{
/**
* @Route('/some-route', defaults={"_format" = "json"})
*/
public function someAction() {
throw new ApiProblemException(
new HttpApiProblem('400', 'It aint all bad ...')
);
}
}
```
When the controller is marked as a "json" format, the request `Content-Type` is `*/json` or the request `Accept` header first value contains json (i.e. `application/json, text/html`), this bundle kicks in.
It will transform the exception to following response:
Headers:
```
Content-Type: application/problem+json
```
Body:
```json
{
"status": 400,
"type": "http:\/\/www.w3.org\/Protocols\/rfc2616\/rfc2616-sec10.html",
"title": "Bad Request",
"detail": "It ain't all bad ..."
}
```
As an alternative, use ```ApiProblemHttpException``` instead of ```ApiProblemException```, to make it possible to
[exclude the specific status code from the log](https://symfony.com/doc/current/logging/monolog_exclude_http_codes.html)
## Adding custom exception transformations
Currently, we automatically transform exceptions from following packages to an ApiProblem instance:
- phpro/api-problem
- symfony/http-kernel
- symfony/security
Besides that, all other errors are transformed to a basic `ExceptionApiProblem` instance.
If you want to add custom transformations, you can implement the `ExceptionTransformerInterface`
and register it in the symfony container with the `phpro.api_problem.exception_transformer` tag.
```php
use Phpro\ApiProblemBundle\Transformer\ExceptionTransformerInterface;
class MyTransformer implements ExceptionTransformerInterface
{
public function transform(\Throwable $exception): ApiProblemInterface
{
return new MyApiProblem($exception);
}
public function accepts(\Throwable $exception): bool
{
return $exception instanceof MyException;
}
}
```
## About
### Submitting bugs and feature requests
Bugs and feature request are tracked on [GitHub](https://github.com/phpro/api-problem-bundle/issues).
Please take a look at our rules before [contributing your code](CONTRIBUTING).
### License
api-problem-bundle is licensed under the [MIT License](LICENSE).