README

一个简单的 Zend Framework 2 模块，它根据 application/api-problem+json 标准返回异常作为 json。

安装

将以下内容添加到您的 composer 根目录

"require": {
    "zoopcommerce/maggott-module" : "~1.1"
}

将模块添加到您的应用程序配置中

'modules' => [
    'Zoop\MaggottModule'
],

配置

您想要返回为 json 的任何异常都需要在 exception_map 配置键中进行配置。

例如

'zoop' => [
    'maggott' => [
        'exception_map' => [
            'Zoop\ShardModule\Exception\AccessControlException' => [
                'described_by' => 'access-control-exception',
                'title' => 'Access denied',
                'status_code' => 403,
                'extra_fields' => ['action'],
                'restricted_extra_fields' => ['documentClass']
            ]
        ]
    ],
]

exception_map 是配置异常的数组。数组中每个项目的键必须是异常的 FQCN。所有配置异常的字段都是可选的。它们是：

described_by

如果提供此字段，返回的异常将有一个 described_by 字段，它指向一个资源，可以在其中找到更多关于异常的信息，格式为人类可读。

如果使用 described_by 字段，您还应该创建一个名为 zoop/maggott/<described_by> 的视图模型模板，其中包含额外的可读信息。

title

异常的标题

status_code

如果 json 响应应设置为 HTTP 状态码，则默认为 500，但也观察响应中的状态码。

extra_fields

应该始终包含在 json 响应中的异常的其他属性。

restricted_extra_fields

如果将 displayExceptions 设置为 true，则应仅包括在 json 响应中的异常的其他属性。

zoopcommerce / maggott-module

维护者

详细信息