黑马程序员技术交流社区

标题: 【上海校区】flask_restful基本使用 [打印本页]

---

作者: 梁强    时间: 2020-2-26 15:03
标题: 【上海校区】flask_restful基本使用
基本使用扩展介绍

• Flask-restful 是一个Flask扩展，它添加了快速构建 REST API的支持
  
  

环境安装pip install flask-restful文档

• 中文翻译：http://www.pythondoc.com/Flask-RESTful/index.html
  
  

构建RESTAPI

• 使用flask-restful构建RESTAPI只需要进行三步操作
  • 创建扩展、组件对象
  • 定义类视图
  • 组件添加类视图
    
    
  
  

#### 代码示例

[Python] 纯文本查看 复制代码

from flask import Flask

from flask_restful import Api, Resource



app = Flask(__name__)

# 创建API对象

api = Api(app)



# 定义类视图 继承Resource

class DemoResource(Resource):

  def get(self):

    return {'foo':'get'}

  def post(self):

    return {'foo':'post'}



# 添加类视图 函数标记默认为类名小写

api.add_resource(DemoResource, '/', endpoint='demo')



if __name__ == '__main__':

  print(app.url_map)

  app.run(debug=True)

• 类视图的优点
  • 一个类视图里面可以处理不同的HTTP请求方法
  • 帮助构建JSON返回数据
    
    
  
  

类视图设置装饰器

• 通过 method_decorators类属性来设置类视图的装饰器
• 该属性接收两种类型数据
  • 列表形式：所有请求方式都会使用列表中的装饰器
  • 字典形式：给请求方式分别设置装饰器
    
    
  
  

代码示例

[Python] 纯文本查看 复制代码

from flask import Flask

from flask_restful import Api, Resource



app = Flask(__name__)

api = Api(app)





def decorator1(func):

    def wrapper(*args, **kwargs):

        print('decorator1')

        return func(*args, **kwargs)



    return wrapper





def decorator2(func):

    def wrapper(*args, **kwargs):

        print('decorator2')

        return func(*args, **kwargs)



    return wrapper





class DemoResource(Resource):

    # method ① 列表形式 设置method_decorators类属性

    method_decorators = [decorator1, decorator2]

    # method_decorators = {

    #     'get': [decorator1],

    #     'post': [decorator2]

    # }



    def get(self):

        return {'foo': 'get'}



    def post(self):

        return {'foo': 'post'}





api.add_resource(DemoResource, '/', endpoint='demo')



if __name__ == '__main__':

    app.run(debug=True)

蓝图和类视图

• 蓝图和类视图可以配合使用，步骤如下：
  • 创建蓝图对象
  • 每个蓝图分别创建组件对象
  • 组件对象添加类视图
  • 应用注册蓝图
    
    
  
  

代码示例

• 在 user包中创建 views文件，定义类视图
  
  

[Python] 纯文本查看 复制代码

# user/views.py

from flask_restful import Resource



class DemoResource(Resource):

  

  def get(self):

    return {'foo': 'get'}

  

  def post(self):

    return {'foo': 'post'}

• user包的初始化文件 __init__.py中
  
  
  • 创建蓝图对象
  • 通过蓝图对象创建对应的组件对象
  • 组件对象添加类视图
    
    

[Python] 纯文本查看 复制代码

from flask import Blueprint

from flask_restful import Api

from .views import DemoResource



# 创建蓝图对象

user_blue = Blueprint('user', __name__)

# 通过蓝图对象创建对应的组件对象

user_api = Api(user_blue)

# 组件对象添加类视图

user_api.add_resource(DemoResource, '/')

• 想要让蓝图对象能够完成路由定义，还需要 Flask应用注册蓝图对象
  
  

[Python] 纯文本查看 复制代码

# main.py

from flask import Flask

from user import user_blue



app = Flask(__name__)

app.register_blueprint(user_blue)



if __name__ == '__main__':

  print(app.url_map)

  app.run(debug=True)

请求请求解析

• flask-restful实现了
  • 参数解析 RequestParser
  • 序列化 marshal
    
    
• flask-restful没有提供数据保存功能，数据存储可以使用后续的 flask-sqlalchemy扩展来完成
• RequestParser负责请求解析工作，基本步骤如下：
  • 创建请求解析器
  • 添加参数规则
  • 执行解析
  • 获取参数
    
    
  
  

代码示例

[Python] 纯文本查看 复制代码

from flask import Flask

from flask_restful import Resource, Api

from flask_restful.reqparse import RequestParser



app = Flask(__name__)

api = Api(app)



class DemoResource(Resource):

  def get(self):

    # ① 创建解析器

    parser = RequestParser()

    # ② 添加参数规则

    parser.add_argument('name')

    parser.add_argument('age')

    # ③ 执行解析

    args = parser.parse_args()

    # ④ 获取参数

    print(args.name)

    print(args.age)

    

    return {'foo': 'get'}

  

api.add_resource(DemoResource, '/', endpoint='demo')

if __name__ == '__main__':

  print(app.url_map)

  app.run(debug=True)

常用参数

参数

说明

取值

default给参数设置默认值，如果不传递该参数就会使用默认值True/False
required是否必须传递，默认False，如果设置为True，不传递会返回400True/False
location设置参数提取的位置args/form/json/files/headers/
type设置参数的转换类型（类型转换 & 格式校验）函数引用，int/内置类型/自定义函数代码示例

• default & required & location参数
  
  

[Python] 纯文本查看 复制代码

from flask import Flask

from flask_restful import Resource, Api

from flask_restful.reqparse import RequestParser



app = Flask(__name__)

api = Api(app)





class DemoResource(Resource):

    def post(self):

        parser = RequestParser()

        parser.add_argument('name', required=True, location='json')

        parser.add_argument('age', default=18)

        args = parser.parse_args()

        print(args.name)

        print(args.age)

        return {'foo': 'get'}





api.add_resource(DemoResource, '/', endpoint='demo')



if __name__ == '__main__':

    app.run(debug=True)

• type 参数
  
  

[Python] 纯文本查看 复制代码

from flask import Flask

from flask_restful import Resource, Api

from flask_restful.inputs import boolean, date, datetime_from_iso8601, int_range, regex

from flask_restful.reqparse import RequestParser



app = Flask(__name__)

api = Api(app)





def custom_func(value):

    if int(value) < 18:

        raise ValueError('没有满18岁')

    else:

        return value





class DemoResource(Resource):

    def post(self):

        parser = RequestParser()

        parser.add_argument('name', required=True, location='json')

        # parser.add_argument('age', default=18, type=int)

        # parser.add_argument('age', default=18, type=boolean)

        # parser.add_argument('age', default=18, type=date)  # xx-xx-xx

        # parser.add_argument('age', default=18, type=datetime_from_iso8601)

        # parser.add_argument('age', default=18, type=int_range(1, 10))

        # parser.add_argument('age', default=18, type=regex(r'1[3-9]\d{9}'))

        parser.add_argument('age', type=custom_func)



        args = parser.parse_args()

        print(args.name)

        print(args.age)



        print(type(args.age))

        return {'foo': 'get'}





api.add_resource(DemoResource, '/', endpoint='demo')



if __name__ == '__main__':

    app.run(debug=True)

响应序列化

• flask_restful通过marshal函数来完成序列化处理
• 操作步骤如下：
  • 定义序列化规则
  • marshal函数按照序列化规则 将模型对象转为字典
    
    
• 常用序列化类型
  
  

序列化类型

说明

String可转换 字符串类型属性
Integer可转换 整数类型属性
Float可转换 浮点数类型属性
List可转换 列表类型属性，要求列表中元素类型唯一
Nested可转换 字典类型属性代码示例

[Python] 纯文本查看 复制代码

from flask import Flask

from flask_restful import Resource, Api, marshal, fields



app = Flask(__name__)

api = Api(app)





class User:

    def __init__(self):

        self.name = 'itcast'

        self.age = 20

        self.height = 1.8

        self.scores = [100, 99]

        self.info = {

            'gender': True

        }





serializer = {

    'username': fields.String(attribute='name'),

    'age': fields.Integer(default=10),

    'height': fields.Float,

    'scores': fields.List(fields.Integer),

    'info': fields.Nested({'gender': fields.Boolean})

}





class DemoResource(Resource):

    def get(self):

        user = User()

        return marshal(user, serializer, envelope='data')





api.add_resource(DemoResource, '/')



if __name__ == '__main__':

    app.run(debug=True)

• 序列化还有一种装饰器形式 marshal_with,使用装饰器形式则试图可以直接返回模型对象
  
  

[Python] 纯文本查看 复制代码

from flask import Flask

from flask_restful import Resource, Api, marshal, fields, marshal_with



app = Flask(__name__)

api = Api(app)





class User:

    def __init__(self):

        self.name = 'itcast'

        self.age = 20

        self.height = 1.8

        self.scores = [100, 99]

        self.info = {

            'gender': True

        }





serializer = {

    'username': fields.String(attribute='name'),

    'age': fields.Integer(default=10),

    'height': fields.Float,

    'scores': fields.List(fields.Integer),

    'info': fields.Nested({'gender': fields.Boolean})

}





class DemoResource(Resource):

    method_decorators = {

        'get': [marshal_with(serializer, envelope='data')]

    }



    def get(self):

        user = User()

        return user



api.add_resource(DemoResource, '/')



if __name__ == '__main__':

    app.run(debug=True)

---

欢迎光临 黑马程序员技术交流社区 (http://bbs.itheima.com/)

黑马程序员IT技术论坛 X3.2