error-handling - 如何在 Apigility 中使用 validation_messages 和 display_exceptions？

Question

从 Apigility 文档（错误报告）：

API 问题规范允许您编写任何其他您认为有助于进一步阐明问题及其发生原因的附加字段。Apigility 利用这一事实以多种方式提供更多信息：

• 验证错误消息通过validation_messages密钥报告。
• display_exceptions启用视图配置设置后，堆栈跟踪将通过和trace属性exception_stack包含在内。

我不明白文档的这一部分。目的是什么以及如何使用这些设置validation_messages？display_exceptions

Answer 1

该display_exceptions设置来自 ZF2 的视图管理器（请参阅此处的文档）。开启此功能将导致 Apigiltiy 包含带有任何错误响应的堆栈跟踪。

在 Apigility 本身中，validation_messages关键群体是自动处理的。您配置一个输入过滤器来验证传入的数据有效负载，如果输入过滤器失败，它返回的错误消息会自动注入到validation_messages密钥下的 API 响应中。此功能由模块提供zf-content-validation。您可以通过 ApiProblemResponse从您的资源中返回一个来“自己做”，如下所示：

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