How to configure exception format using FOSRestBundle and Symfony 2?

Question

I am using FOSRestBundle with Symfony 2 to implement the REST API in JSON format.

I want all API exceptions to be returned in a specific JSON format as follows:

{ "success": false, "exception": { "exceptionClass": "SomeNastyException", "message": "A nasty exception occurred" } } 

How to do it?

I tried to mess with the ExceptionController , but the logic seems too complicated to be easily overloaded.

Answer 1

Note This only works for FOSResBundle <2.0. For FOSResBundle> = 2.0, use Exceptional Normalizers, see examples .

You can write your own exception wrapper handler, for example, in docs . In your case:

 <?php //AppBundle\Handler\MyExceptionWrapperHandler.php namespace AppBundle\Handler; use FOS\RestBundle\Util\ExceptionWrapper; use FOS\RestBundle\View\ExceptionWrapperHandlerInterface; class MyExceptionWrapperHandler implements ExceptionWrapperHandlerInterface { public function wrap($data) { /** @var \Symfony\Component\Debug\Exception\FlattenException $exception */ $exception = $data['exception']; $newException = array( 'success' => false, 'exception' => array( 'exceptionClass' => $exception->getClass(), 'message' => $data['status_text'] ) ); return $newException; } } 

---

application /Config/config.yml

 fos_rest: routing_loader: default_format: json view: view_response_listener: force exception_wrapper_handler: AppBundle\Handler\MyExceptionWrapperHandler exception: enabled: true 

Answer example:

 {"success":false,"exception":{"exceptionClass":"Symfony\\Component\\HttpKernel\\Exception\\NotFoundHttpException","message":"Not Found"}} 

Answer 2

I have landed several times on this subject over the past few days. For anyone else in my situation when you are using a V2 package, you can find the following resource when updating the useful use of FOSRestBundle.

It covers the use of serializer instead of ExceptionWrapperHandlerInterface.

https://github.com/FriendsOfSymfony/FOSRestBundle/blob/master/UPGRADING-2.0.md

• Excluded configuration option exception_wrapper_handler. the use of normalizers.

Before:

config.yml

 fos_rest: view: exception_wrapper_handler: AppBundle\ExceptionWrapperHandler 

Handler

 namespace AppBundle; class ExceptionWrapperHandler implements ExceptionWrapperHandlerInterface { public function wrap($data) { return new ExceptionWrapper(array('status_code' => 'foo')); } } 

After (if you use the symfony serializer):

services.yml

 services: app_bundle.exception_normalizer: class: AppBundle\Normalizer\ExceptionNormalizer tags: - { name: serializer.normalizer } 

normalizer

 namespace AppBundle\Normalizer; use Symfony\Component\Serializer\Normalizer\NormalizerInterface; class ExceptionNormalizer implements NormalizerInterface { public function normalize($object, $format = null, array $context = array()) { return array('status_code' => 'foo'); } public function supportsNormalization($data, $format = null) { return $data instanceof \My\Exception; } }