This bundle provides support for RFC 9457.
- Turns
ValidationFailedException
exceptions into aProblemDetails
responses complying with RFC 9457.- The error building is fully customizable.
- Provides a
ProblemDetailsFactory
service to createProblemDetails
instances.
composer require phauthentic/problem-details-symfony-bundle
Simply inject the ProblemDetailsFactoryInterface
into your handlers and use it to create ProblemDetails
responses.
class ExampleController { public function __construct( private ProblemDetailsFactoryInterface $problemDetailsFactory ) { } /** * @Route("/example", methods={"POST"}) */ public function exampleAction(Request $request): Response { return $this->problemDetailsFactory->createResponse( type: 'https://example.net/validation-error', detail: 'Your request is not valid.', status: 422, title: 'Validation Error', ); } }
To add more converters to the kernel listener, you can tag additional services with phauthentic.problem_details.exception_converter
. They must implement the ExceptionConverterInterface.
Phauthentic\Symfony\ProblemDetails\ExceptionConversion\ValidationFailedExceptionConverter: arguments: $validationErrorsBuilder: '@Phauthentic\Symfony\ProblemDetails\Validation\ValidationErrorsBuilder' $problemDetailsResponseFactory: '@Phauthentic\Symfony\ProblemDetails\FromExceptionEventFactoryInterface' tags: ['phauthentic.problem_details.exception_converter']
To completely override the list of already configured listeners override
Phauthentic\Symfony\ProblemDetails\ThrowableToProblemDetailsKernelListener: public: true arguments: $exceptionConverters: !tagged_iterator phauthentic.problem_details.exception_converter tags: - { name: 'kernel.event_listener', event: 'kernel.exception', priority: 0 }
in your services.yaml
.
HTTP/1.1 422 Unprocessable Content Content-Type: application/problem+json Content-Language: en { "type": "https://example.net/validation-error", "title": "Your request is not valid.", "errors": [ { "detail": "must be a positive integer", "pointer": "#/age" }, { "detail": "must be 'green', 'red' or 'blue'", "pointer": "#/profile/color" } ] }
If you favor a different style of implementation check out the following bundles:
This bundle is under the MIT license.
Copyright Florian Krämer