Flask中如何自定义上传文件超限的REST API报错信息与状态码
自定义Flask上传大小超限的413 JSON响应实现方案
核心原理
设置app.config['MAX_CONTENT_LENGTH']后,请求体超出阈值时,Werkzeug会直接抛出内置的RequestEntityTooLarge异常,默认走通用错误流程返回HTML页面。只需要给这个异常注册自定义的错误处理器,就能完全替换默认响应,返回符合REST规范的JSON内容。
具体实现步骤
- 导入依赖的异常类和Flask内置工具
from flask import Flask, make_response from werkzeug.exceptions import RequestEntityTooLarge import json
- 保留你已有的上传大小上限配置
app = Flask(__name__) # 原有1MB上传大小上限配置无需改动 app.config['MAX_CONTENT_LENGTH'] = 1024 * 1024
- 注册413异常的全局处理逻辑
@app.errorhandler(RequestEntityTooLarge) def file_size_limit_handler(error): # 完全按照你要求的格式返回自定义响应 return make_response( json.dumps({'error_message': 'file size too large'}), 413 )
方案特点
- 全局生效:框架层面在请求解析阶段就完成大小校验,不需要在每个上传路由里重复写手动校验逻辑,避免冗余代码
- 性能更优:大请求体在进入路由逻辑前就会被拦截,不会占用多余的服务端资源
- 无侵入:原有上传业务逻辑不需要任何改动,只需要新增一段错误处理代码即可生效
注意:该错误处理器不受Flask DEBUG模式开关影响,不管是开发环境还是生产环境,只要触发413超限就会返回自定义响应。
验证方式
用curl发送一个超过1MB的文件到上传接口,返回内容将是自定义JSON格式的报错,不再展示默认的HTML版413 Request Entity Too Large页面。
内容的提问来源于stack exchange,提问作者user1584421
相关产品推荐
相关产品推荐

