flask路由分模块管理及自定义restful响应格式详解

 更新时间:2022年08月18日 11:29:02   作者:你华还是你华  
这篇文章主要为大家介绍了flask路由分模块管理及自定义restful响应格式详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

一、flask路由分模块管理

1.1、使用蓝图

在flask中可以使用蓝图Blueprint来进行创建路由进行分模块。 具体操作,我们可以在项目根目录下创建一个controller文件夹来存储分模块的路由。

在controller文件夹里创建product_controller.py,在里面如下写法引入蓝图,并且注册蓝图:

from flask import Blueprint
product_blue = Blueprint('product', __name__)
# 定义蓝图路径及请求方法和请求返回逻辑
@product_blue.route('/get', methods=['get', 'post'])
def getproduct():
	return 'product'
@product_blue.route('/search', methods=['get', 'post'])
def searchproduct():
	return 'search'

那么我们在项目主逻辑文件main.py中,去引入并注册这个蓝图:

from flask import Flask
from controller.product_controller import product_blue
app = Flask(__name__)
# 商品模块
app.register_blueprint(product_blue, url_prefix='/product')
if __name__ == '__main__':
    app.run()

接下来我们运行程序,可以看到如下效果:

可以看到我们使用蓝图分模块的创建已经生效了,这样如果模块对的话,我们就方便管理了。不会造成代码全部冗余在一个主文件中。

1.2、使用flask_restful

那么相比与蓝图Blueprint,flask_restful的优势就在于它能够做更多的操作,比如参数的验证,返回直接字典就能解析成json

首先我们输入命令pip3 install flask_restful安装flask_restful。 在product_controller中写入如下代码:

from flask_restful import Resource, reqparse
class ProductView(Resource):
    @staticmethod
    def post():
        parse = reqparse.RequestParser()
        parse.add_argument('product_id', type=str, help='商品id必传', required=True, trim=True)
        args = parse.parse_args()
        product_id = args.product_id
        return {
            'msg': '商品id是' + product_id,
            'code': 200
        }
    @staticmethod
    def get():
        return {
            'msg': '商品',
            'code': 200
        }

那么main.py主文件中修改如下:

from controller.product_controller import ProductView
app = Flask(__name__)
api = Api(app)
api.add_resource(ProductView, '/product', endpoint='product')
if __name__ == '__main__':
    app.run()

现在已经是restful形式的api了,我们采用apifox或者postman测试请求接口如下:

可以看到get请求成功,但是在post请求时,我们没有传必传参数,所以出现了报错。我们尝试将必传参数加上:

那么可以看到将必传的参数加上后,请求成功。 两种模式可以共存,但是一般我们只用一种就行了。

相信细心的小伙伴已经发现,失败和成功返回的数据格式不一样,成功有code,失败却没有code,那么我想自定义失败返回的数据格式,将怎么操作呢,接下来自定义flask_restful的错误响应。

二、自定义flask_restful响应格式

在根目录下创建errors.py,写入如下代码:

"""
design the custom error response of flask-restful
"""
from flask_restful import abort
def generate_response(msg, status):
    return {
            'code': status,
            'msg': msg,
        }
def custom_abort(http_status_code, *args, **kwargs):
    if http_status_code == 400:
        abort(400, **generate_response(msg=[kwargs.get('message')], status=http_status_code))
    abort(http_status_code)

我们将错误状态拎出来自定义返回格式。 在main.py主文件中加入这两行代码:

from errors import custom_abort
flask_restful.abort = custom_abort

效果如下:

可以看到我们成功的返回了相同的数据结构。

以上就是flask路由分模块管理及自定义restful响应格式详解的详细内容,更多关于flask路由管理restful响应格式的资料请关注脚本之家其它相关文章!

相关文章

  • Python编程新标准学会十项好习惯提升编码质量

    Python编程新标准学会十项好习惯提升编码质量

    这篇文章主要为大家介绍了Python编程新标准学会十项好习惯提升编码质量,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2024-01-01
  • Python tkinter 列表框Listbox属性详情

    Python tkinter 列表框Listbox属性详情

    这篇文章主要介绍了Python tkinter 列表框Listbox属性详情,列表框控件显示多行文本,用户可以选中一行或者多行。所有的文本只能使用一种字体,不能混合使用多种字体
    2022-07-07
  • Python中rasterio库的实现

    Python中rasterio库的实现

    Rasterio是一个用于读写光栅数据的Python库,它专注于快速和可靠地处理大规模地理空间栅格数据,本文主要介绍了Python中rasterio库的实现,感兴趣的可以了解一下
    2025-04-04
  • 用于ETL的Python数据转换工具详解

    用于ETL的Python数据转换工具详解

    这篇文章主要介绍了用于ETL的Python数据转换工具,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-07-07
  • Django中模型Model添加JSON类型字段的方法

    Django中模型Model添加JSON类型字段的方法

    这篇文章主要介绍了Django中模型Model添加JSON类型字段的方法,实例分析了Python的Django框架模型使用技巧,需要的朋友可以参考下
    2015-06-06
  • python读csv文件时指定行为表头或无表头的方法

    python读csv文件时指定行为表头或无表头的方法

    这篇文章主要介绍了python读csv文件时指定行为表头或无表头的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-06-06
  • Python实现程序判断季节的代码示例

    Python实现程序判断季节的代码示例

    今天小编就为大家分享一篇关于Python实现程序判断季节的代码示例,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-01-01
  • python 随机数使用方法,推导以及字符串,双色球小程序实例

    python 随机数使用方法,推导以及字符串,双色球小程序实例

    下面小编就为大家带来一篇python 随机数使用方法,推导以及字符串,双色球小程序实例。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-09-09
  • python入门turtle库实现螺旋曲线图的方法示例

    python入门turtle库实现螺旋曲线图的方法示例

    turtle(海龟)是Python重要的标准库之一,它能够进行基本的图形绘制,本文就来介绍了一下python入门turtle库实现螺旋曲线图的方法示例,感兴趣的可以了解一下
    2021-11-11
  • openCV入门学习基础教程第二篇

    openCV入门学习基础教程第二篇

    人脸识别,物体检测,OpenCV是基石,下面这篇文章主要给大家介绍了关于openCV入门学习基础教程的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-11-11

最新评论