Как использовать validation_messages и display_exceptions в Apigility?

Question

Из Apigility документации (Error Reporting):

В API спецификация Проблема позволяет создавать любые другие дополнительные поля, которые вы чувствуете, что поможет в дальнейшем прояснить эту проблему, и почему это произошло. Apigility использует этот факт для предоставления дополнительной информации несколькими способами:

• Сообщения об ошибках проверки сообщаются с помощью ключа validation_messages.
• Когда настройка конфигурации просмотра display_exceptions включена, трассировка стека включена через trace и exception_stack.

Я не понимаю эту часть документа. Что такое цель и как использовать настройки validation_messages и display_exceptions?

Answer 1

display_exceptions уточняется у менеджера функции ZF2 (see docs here). Включение этого приведет к тому, что Apigiltiy будет включать трассировку стека с любым ответом на ошибку.

В самой Apigility ключевой популяции обрабатывается автоматически. Вы настраиваете входной фильтр, который проверяет полезную нагрузку входящих данных, и если входной фильтр выходит из строя, сообщения об ошибках, которые он возвращает, автоматически вводятся в ответ API под ключом validation_messages. Эта функциональность обеспечивается модулем zf-content-validation. Вы можете «сделать это сами», вернув ApiProblemResponse с вашего ресурса следующим образом:

return new ApiProblemResponse(
    new ApiProblem(422, 'Failed Validation', null, null, array(
     'validation_messages' => [ /* array of messages */ ] 
    )) 
);