如何在webapp2中JSON格式化HTTP错误响应

时间:2013-03-26 22:27:20

标签: json google-app-engine error-handling webapp2

我在App Engine中使用webapp2进行开发。我想要做的是发送错误时自定义JSON格式的响应。例如,当请求长度大于阈值时,用HTTP 400和响应主体响应

{'error':'InvalidMessageLength'}

在webapp2中,可以选择为某些异常分配错误处理程序。例如:

app.error_handlers[400] = handle_error_400

handle_error_400如下:

def handle_error_400(request, response, exception):
    response.write(exception)
    response.set_status(400)

执行webapp2.RequestHandler.abort(400)时,执行上述代码。

如何基于上述设置动态地使用不同的响应格式(HTML和JSON)?也就是说,如何调用handle_error_400函数的不同版本?

1 个答案:

答案 0 :(得分:5)

这是一个完整的工作示例,演示了如何为所有类型的错误设置相同的错误处理程序,如果您的网址以/json开头,则响应将为application/json(使用您的想象力如何充分利用request对象来决定应该提供什么样的响应:

import webapp2
import json

def handle_error(request, response, exception):
  if request.path.startswith('/json'):
    response.headers.add_header('Content-Type', 'application/json')
    result = {
        'status': 'error',
        'status_code': exception.code,
        'error_message': exception.explanation,
      }
    response.write(json.dumps(result))
  else:
    response.write(exception)
  response.set_status(exception.code)

app = webapp2.WSGIApplication()
app.error_handlers[404] = handle_error
app.error_handlers[400] = handle_error

在上面的示例中,您可以通过访问以下网址来轻松测试不同的行为,这些网址将返回404,这是最容易测试的错误:

http://localhost:8080/404
http://localhost:8080/json/404