Flask-restful 用法及自定义参数错误信息
2018-03-07 10:57
441 查看
转自:https://segmentfault.com/a/1190000012281928
flask-restful 是一款比较好用的 flask 插件,它不仅自动为我们实现了数据的 json 化,还能对传入参数进行验证,优雅的替代了 form 表单。代码结构:
flask-restful 是一款比较好用的 flask 插件,它不仅自动为我们实现了数据的 json 化,还能对传入参数进行验证,优雅的替代了 form 表单。代码结构:
app |_api | |_ __init__.py | |_ parser.py | |_ view.py | |_ __init__.py |_ code.py |_ util.py app.py具体代码如下:
parser.py from flask_restful.reqparse import RequestParser parser = RequestParser() parser.add_argument("id", type=int, location="args", required=True) # get 请求为args, post请求为json在 view 中的使用view.py
from flask_restful import Resource from app.util import make_result from .parser import parser class Test(Resource): def get(self): req = parser.parse_args(strict=True) id = req.get("id") return make_result(data={"id": id})还有 __init__.py 文件设置路由__init__.py
from .view import Test from flask_restful import Api from flask import Blueprint api = Blueprint("api", __name__) # 设置蓝图 resource = Api(api) resource.add_resource(Test, "/") # 设置路由util.py 为一个设置文件, 用来放我们自己定义的输出规范。util.py
from flask import jsonify from app.code import Code def make_result(data=None, code=Code.SUCCESS): return jsonify({"code": code, "data": data, "msg": Code.msg[code]})code.py 是我们自定义的错误码code.py
class Code: SUCCESS = 1200 NO_PARAM = 1300 msg = { SUCCESS: "success", NO_PARAM: "no param" }app.py 为启动文件
app.py from flask import Flask from app.api import api app = Flask(__name__) app.register_blueprint(api) if __name__ == "__main__": app.run(debug=True)当我们运行 python app.py 的时候,程序便启动了起来。我们在浏览器中输入:localhost:5000/?id=123即可看到:
{ "code": 1200, "data":{ "id": 123 }, "msg": "success" }那当我们输入: localhost:5000/?id=api得到了:
{ "message":{ "id": "invalid literal for int() with base 10: 'api'" } }很明显,我们期望得到一个 int 型的 id,这里给了一个 str 类型的字符串,于是得到了 status_code 为 40 0的 response。我们肯定是希望以我们自己的定义消息来输出,即:
{ "code": 1300, "data": null, "msg": "no param" }flask-restful 并没有提供相应的 api,经过查看源码,发现 flask-restful abort 的代码是改写的 flask 的 abort 代码,于是我们也改写 flask-restful 的 abort 代码。flask abort 源码:
def abort(status, *args, **kwargs): return _aborter(status, *args, **kwargs)非常简单。flask-restful 的 abort 源码:
def abort(http_status_code, **kwargs): try: original_flask_abort(http_status_code) except HTTPException as e: if len(kwargs): e.data = kwargs raise也是非常的简单,这里的 original_flask_abort 即 flask 的 abort。那现在改代码就很容易了,只要 http_status_code == 400,那么就是我们的参数没有接受正确,需要爆出格式化以后的错误。在 app.py 中修改:app.py
from flask import Flask, abort import flask_restful from app.api import api from app.util import make_result from app.code import Code app = Flask(__name__) app.register_blueprint(api) def custom_abord(http_status_code, *args, **kwargs): # 只要http_status_code 为400, 报参数错误 if http_status_code == 400: abort(make_result(code=Code.NO_PARAM)) # 正常返回消息 return abort(http_status_code) # 把flask_restful中的abort方法改为我们自己定义的方法 flask_restful.abort = custom_abord if __name__ == "__main__": app.run(debug=True)现在再次运行 python app.py浏览器输入:http://localhost:5000/?id=api即可得到:
{ "code": 1300, "data": null, "msg": "no param" }输入:http://localhost:5000/?id=111 检测一下正常输出:
{ "code": 1200, "data":{ "id": 111 }, "msg": "success" }
相关文章推荐
- 自定义 IIS 6 错误信息吗?
- ASP.NET中MVC使用AJAX调用JsonResult方法并返回自定义错误信息
- 根据参数提示错误信息
- 自定义错误信息并写入到Elmah
- OleDb与Access数据访问中日期时间参数类型错误和命名参数的用法
- 服务器上出现应用程序错误。此应用程序的当前自定义错误设置禁止远程查看应用程序错误的详细信息(出于安全原因)。但可以通过在本地服务器计算机上运行的浏览器查看。
- Linux中last的用法及参数,查看登陆系统用户的信息
- 服务器上出现应用程序错误。此应用程序的当前自定义错误设置禁止远程查看应用程序错误的详细信息(出于安全原因)。
- Ruby On Rails 自定义错误页面的显示信息 指定显示页面
- MVC验证06-自定义错误信息
- web.config 自定义错误信息
- javascript 自定义错误信息
- 如何自定义Struts2表单验证后的错误信息显示格式/样式
- linux dmesg命令参数及用法详解(linux显示开机信息命令)
- MVC数据验证原理及自定义ModelValidatorProvider实现无编译修改验证规则和错误信息
- linux whois命令参数及用法详解(linux查询域名或IP注册信息)
- initcall_debug参数定位初始化过程的错误信息发生的位置
- 如何自定义Struts2表单验证后的错误信息显示格式
- 用err.raise自定义错误信息