From afea912a75a7b0e9be24811b8b4b1ad4326b1c4a Mon Sep 17 00:00:00 2001 From: Akshay Date: Fri, 19 Feb 2016 11:52:50 +0530 Subject: [ci skip] Need to mention debug_exception_response_format in the api_app documentation. - #23771 removed the reference to debug_exception_response_format from the api_app documentation. - We need to let users know, they have ability to configure debug_exception_response_format in their development environment. - Added documentation for the same in api_app.md file - Grammar corrections --- guides/source/api_app.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/guides/source/api_app.md b/guides/source/api_app.md index 0598b9c7fa..8dba914923 100644 --- a/guides/source/api_app.md +++ b/guides/source/api_app.md @@ -166,6 +166,23 @@ class definition: config.api_only = true ``` +In `config/environments/development.rb`, set `config.debug_exception_response_format` +to configure the format used in responses when errors occur in development mode. + +To render an HTML page with debugging information, use the value `:default`. + +```ruby +config.debug_exception_response_format = :default +``` + +To render debugging information preserving the response format, use the value `:api`. + +```ruby +config.debug_exception_response_format = :api +``` + +By default, `config.debug_exception_response_format` is set to `:api`. + Finally, inside `app/controllers/application_controller.rb`, instead of: ```ruby -- cgit v1.2.3