zolfa / readable-api-error-response-bundle
此包的最新版本(dev-master)没有可用的许可证信息。
dev-master
2016-06-20 11:05 UTC
Requires
- php: >=5.3.0
- symfony/symfony: >=2.3.0
This package is not auto-updated.
Last update: 2024-09-24 20:47:55 UTC
README
此bundle通常与FOSRestBundle一起使用,以返回可读的异常消息。
默认情况下,当控制器抛出异常时,会返回一个状态码为500的响应,内容设置为"内部错误"。然而,问题是您抛出的包含有用信息的异常会丢失。
这意味着您无法向将使用您的API的开发者提供有用的错误消息,您的UI应用程序也无法向最终用户提供有用的消息。
此bundle可以让您通过简单的composer install和在AppKernel中注册bundle来实现这一点。
安装
第1步:下载Bundle
打开命令行界面,进入您的项目目录,并执行以下命令以下载此bundle的最新稳定版本
$ composer require azolf/readable-api-response-bundle
此命令要求您全局安装Composer,如Composer文档中的安装章节所述。
第2步:启用Bundle
然后,通过将其添加到项目app/AppKernel.php文件中注册的bundle列表中来启用bundle。
<?php // app/AppKernel.php // ... class AppKernel extends Kernel { public function registerBundles() { $bundles = array( // ... new <vendor>\<bundle-name>\<bundle-long-name>(), ); // ... } // ... }
用法
这就是您需要做的,以便能够返回对用户和计算机都有意义的异常。为了尝试此bundle,请将以下内容添加到控制器中的一个动作中
public function indexAction() { throw new \Exception('This is a test exception.'); }
现在,在浏览器中打开该页面,您必须看到如下响应