B站: 迷途小书童的Note;微信公众号: Dev_Club;个人微信:xituxiaoshutong100

Flask教程(十六)RESTful-API

Flask Web 迷途小书童 0评论

软硬件环境

视频看这里

此处是youtube的播放链接,需要科学上网。喜欢我的视频,请记得订阅我的频道,打开旁边的小铃铛,点赞并分享,感谢您的支持。

简介

前面我们讲到flask路由的时候,可以通过app.route来指定HTTP的请求方法(GETPOSTPUTDELETE等),并在请求函数中根据不同的请求方法,执行不同的业务逻辑。这样就已经实现一个简单的Restful请求了。但是在flask中有更好的方法来实现,那就是flask-restful扩展了。

RESTful架构风格规定,数据的元操作,即CRUD(即数据的增删查改)操作,分别对应于HTTP方法,GET用来获取资源,POST用来新建资源(也可以用于更新资源),PUT用来更新资源,DELETE用来删除资源,这样就统一了数据操作的接口,仅仅通过HTTP方法,就可以完成对数据的增删查改工作。

安装flask-restful

常规操作,通过pip安装

pip install flask-restful

flask-restful基本使用

插件安装好后,就可以导入模块了,看下面的示例

from flask import Flask, jsonify
from flask_restful import Api, Resource, reqparse

USERS = [
    {"name": "zhangsan"},
    {"name": "lisi"},
    {"name": "wangwu"},
    {"name": "zhaoliu"}
]

class Users(Resource):
    def get(self):
        return jsonify(USERS)

    def post(self):
        args = reqparse.RequestParser() \
            .add_argument('name', type=str, location='json', required=True, help="名字不能为空") \
            .parse_args()

        if args['name'] not in USERS:
            USERS.append({"name": args['name']})

        return jsonify(USERS)

    def delete(self):
        USERS = []
        return jsonify(USERS)


app = Flask(__name__)
api = Api(app, default_mediatype="application/json")

api.add_resource(Users, '/users')

app.run(host='0.0.0.0', port=5001, use_reloader=True)

flask-restful扩展通过api.add_resource()方法来添加路由,方法的第一个参数是一个类名,该类继承Resource基类,其成员方法定义了不同的HTTP请求方法的逻辑;第二个参数定义了URL路径。在Users类中,我们分别实现了getpostdelete方法,分别对应HTTPGETPOSTDELETE请求。

另外,flask-restful还提供了argparse,它可以方便地实现对http请求中客户端发送过来的数据进行校验处理,这有点像表单中的验证方法,在实际项目中非常实用。

程序启动以后,我们访问 http://127.0.0.1:5001/usersGET请求时会给出USERS的内容、POST请求时会在USERS中添加一项(如果不存在)并返回USERS更新后的内容。DELETE请求则清空USERS并返回空。

客户端部分,我们使用postman来模拟请求

flask-restful-get

flask-restful-post

flask-restful-delete

GET方法中如何获取参数

针对每个用户名,我们写个类,同样继承自Resource,在get方法中,接收参数userid,简单起见,userid定义为该用户名在USERS列表中的索引

class UserId(Resource):
    def get(self, userid):
        return jsonify(
            {"name": USERS[int(userid)].get("name")}
        )

api.add_resource(UserId, '/user/<userid>')

api.add_resource()方法中,第二个参数/user/<userid>中的<userid>,就是用户传递过来的参数,这点写法上跟flask路由的写法是一模一样的。程序启动后,访问 http://127.0.0.1:5001/user/0 获取的就是USERS列表中第一个用户的信息

flask-restful-get-param

在flask-restful中添加日志

Flask教程(十五)日志 已经提过如何在flask中使用日志功能。在flask-restful中,logger的使用有更优雅的方式,来看示例

import logging.config
from flask import Flask, jsonify
from flask_restful import Api, Resource, reqparse

logging.config.dictConfig(
    {
        "version": 1,
        "disable_existing_loggers": False,
        "formatters": {
            "simple": {"format": "%(asctime)s - %(name)s - %(levelname)s - %(message)s"}
        },
        "handlers": {
            "console": {
                "class": "logging.StreamHandler",
                "level": "DEBUG",
                "formatter": "simple",
                "stream": "ext://sys.stdout",
            },
            "info_file_handler": {
                "class": "logging.handlers.RotatingFileHandler",
                "level": "INFO",
                "formatter": "simple",
                "filename": "info.log",
                "maxBytes": 10485760,
                "backupCount": 50,
                "encoding": "utf8",
            },
            "error_file_handler": {
                "class": "logging.handlers.RotatingFileHandler",
                "level": "ERROR",
                "formatter": "simple",
                "filename": "errors.log",
                "maxBytes": 10485760,
                "backupCount": 20,
                "encoding": "utf8",
            },
            "debug_file_handler": {
                "class": "logging.handlers.RotatingFileHandler",
                "level": "DEBUG",
                "formatter": "simple",
                "filename": "debug.log",
                "maxBytes": 10485760,
                "backupCount": 50,
                "encoding": "utf8",
            },
        },
        "loggers": {
            "my_module": {"level": "ERROR", "handlers": ["console"], "propagate": "no"}
        },
        "root": {
            "level": "DEBUG",
            "handlers": ["error_file_handler", "debug_file_handler"],
        },
    }
)

USERS = [
    {"name": "zhangsan"},
    {"name": "lisi"},
    {"name": "wangwu"},
    {"name": "zhaoliu"}
]

class Users(Resource):
    def __init__(self, **kargs):
        self.logger = kargs.get('logger')

    def get(self):
        return jsonify(USERS)

    def post(self):
        args = reqparse.RequestParser() \
            .add_argument('name', type=str, location='json', required=True, help="名字不能为空") \
            .parse_args()

        self.logger.debug(args)

        if args['name'] not in USERS:
            USERS.append({"name": args['name']})

        return jsonify(USERS)

    def delete(self):
        USERS = []
        return jsonify(USERS)


app = Flask(__name__)
api = Api(app, default_mediatype="application/json")

api.add_resource(Users, '/users', resource_class_kwargs={
    "logger": logging.getLogger('/Users')
})

app.run(host='0.0.0.0', port=5001, use_reloader=True)

我们使用上次用到的dictConfig,主要的区别在于api.add_resource()方法中,使用了参数resource_class_kwargs,然后在Resource子类中的构造函数__init__,将日志记录器获取到,后面就可以在各个处理方法中使用了。再次使用postman发起POST请求,可以看到debug.log是这个样子的

flask-restful-logging

源码下载

https://github.com/xugaoxiang/FlaskTutorial

参考资料

喜欢 (1)
发表我的评论
取消评论

表情

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址