FOSRestBundle configuration of exceptions messages in prod environment

Question

I'm struggling with a problem linked to the FOSRestBundle (version 0.13.*)

I have some REST api that throws some exceptions, nothing unusual I guess. But, despite the specific configuration I made to allow exceptions messages to be formatted in the response even in production (following the documentation I found here : https://github.com/FriendsOfSymfony/FOSRestBundle/blob/master/Resources/doc/4-exception-controller-support.md), the JSON response stays desperately empty...

Example below:

http://host/app_dev.php/api/postcode/search?postcode=

results in:

HTTP 400: {"status":"error","status_code":400,"status_text":"Bad Request","current_content":"","message":"You must provide a postcode"}

BUT

http://host/api/postcode/search?postcode=

results in:

HTTP 400: []

My API controller looks like this:

/**
 * Search post codes
 *
 * @param Request   $request   Request
 * @param Promotion $promotion Promotion
 *
 * @Rest\View()
 *
 * @throws BadRequestHttpException
 * @return array
 */
public function searchAction(Request $request, Promotion $promotion)
{
    // Get post code
    $postCode = $request->query->get('postcode');
    if (!$postCode) {
        throw new BadRequestHttpException('You must provide a postcode');
    }

    // SOME LOGIC HERE TO GET DATA

    return $data;
}

and the fos_rest configuration looks like this:

fos_rest:
    routing_loader:
        default_format: json
    view:
        mime_types:
            json: ['application/json; charset=UTF-8']
        formats:
            json: true
        view_response_listener: force
    format_listener: false
    access_denied_listener:
        json: true
    body_listener: true
    exception:
        messages:
            Symfony\Component\HttpKernel\Exception\BadRequestHttpException: true

As I understood it, the fos_rest.exception.messages configuration array should list the exceptions for which I want a serialization of the error message even in production. As you can see in the code of the controller, this response contains a translated error message that will be displayed to the client. Why is this configuration ignored? I can say for sure that the configuration is properly loaded even in prod environment, because if I mispell the class name in the conf, it fails with a "Could not load class" exception.

What am I missing? Thanks in advance for any hint you could give me...

Hi, would love if you marked my answer as correct or not :D thanks — timhc22, Nov 29 '16 at 19:42

timhc22 · Answer 1 · 2015-06-11T10:25:43.230

I had a similar problem, your question helped me solve it actually! I know it is late but I found that clearing the prod cache helped fixed this for me.

Also these are my settings:

fos_rest:
    param_fetcher_listener: true
    body_listener:
        array_normalizer: fos_rest.normalizer.camel_keys
    format_listener: true
    view:
        view_response_listener: 'force'
        formats:
            json: true
        templating_formats:
            html: true
        force_redirects:
            html: true
        failed_validation: HTTP_BAD_REQUEST
        default_engine: twig
    routing_loader:
        default_format: json
    serializer:
        serialize_null: true
    access_denied_listener:
        json: true
    exception:
        enabled: true
        messages:
            Symfony\Component\HttpKernel\Exception\BadRequestHttpException: true

I'm wondering also whether you always have to explicitly add the exceptions to the codes and messages sections of the config, unless you use the HttpException:

throw new HttpException(400, "New comment is not valid.");

Thank you! `exception.messages` is exactly what I was looking for. — Aistis, Nov 25 '16 at 10:17

score 0 · Answer 2 · answered Oct 15 '14 at 13:31

I haven't tried this but it looks like you forget this line:

 exception:
    codes:
      'Symfony\Component\Routing\Exception\ResourceNotFoundException': 404

give it a try.

and did you mentioned this:

twig:
   ...
   ...
   exception_controller: 'FOS\RestBundle\Controller\ExceptionController::showAction'

FOSRestBundle configuration of exceptions messages in prod environment

2 Answers2

Linked