flask-restful扩展

关键词：

Flask路由可以指定HTTP请求方法，并在请求函数中根据不同的请求方法，执行不同的逻辑。这样实现一个Restful的请求已经相当简单了

Flask还有更简便的方法，就是其Flask-RESTful扩展。首先，我们来安装这个扩展：

pip install Flask-RESTful

安装完后，你就可以在代码中导入该扩展包

from flask import Flask, request
from flask_restful import Api, Resource
 
app = Flask(__name__)
api = Api(app)
 
USER_LIST = {
    ‘1‘: {‘name‘:‘Michael‘},
    ‘2‘: {‘name‘:‘Tom‘},
}
 
class UserList(Resource):
    def get(self):
        return USER_LIST
 
    def post(self):
        user_id = int(max(USER_LIST.keys())) + 1
        user_id = ‘%i‘ % user_id
        USER_LIST[user_id] = {‘name‘: request.form[‘name‘]}
        return USER_LIST[user_id]
 
api.add_resource(UserList, ‘/users‘)
 
if __name__ == ‘__main__‘:
    app.run(host=‘0.0.0.0‘, debug=True)

这个例子很容易理解，Restful扩展通过”api.add_resource()”方法来添加路由，方法的第一个参数是一个类名，该类继承”Resource”基类，其成员函数定义了不同的HTTP请求方法的逻辑；第二个参数定义了URL路径。运行上面的例子并访问”http://localhost:5000/users”，GET请求时会列出全局变量”USER_LIST”中的内容，POST请求时会在”USER_LIST”中添加一项，并返回刚添加的项。如果在POST请求中找不到”name”字段，则返回”400 Bad Request”错误。由于类”UserList”没有定义”put”和”delete”函数，所以在PUT或DELETE请求时会返回”405 Method Not Allowed”错误。

另外，路由支持多路径，比如：

api.add_resource(UserList, ‘/userlist‘, ‘/users‘)

这样访问”http://localhost:5000/userlist”和”http://localhost:5000/users”的效果完全一样。

带参数的请求

上面的例子请求是针对user列表的，如果我们要对某个具体的user做操作，就需要传递具体的”user_id”了。这时候，我们需要路由支持带参数。Flask-RESTful的实现同Flask一样，就是在路由中加上参数变量即可。我们看下例子：

class User(Resource):
    def get(self, user_id):
        return USER_LIST[user_id]
 
    def delete(self, user_id):
        del USER_LIST[user_id]
        return ‘‘
 
    def put(self, user_id):
        USER_LIST[user_id] = {‘name‘: request.form[‘name‘]}
        return USER_LIST[user_id]
 
api.add_resource(User, ‘/users/<user_id>‘)

在”api.add_resource()”的第二个参数路径中加上URL参数变量即可，格式Flask路由中完全一样，也支持转换器来转换变量类型。此外，在User类的GET，POST，PUT等成员函数中，记得加上参数”user_id”来获取传入的变量值。

参数解析

在POST或PUT请求中，直接访问form表单并验证的工作有些麻烦。Flask-RESTful提供了”reqparse”库来简化。我们来改进下上例中的PUT函数：

from flask_restful import reqparse
 
parser = reqparse.RequestParser()
parser.add_argument(‘name‘, type=str)
 
class User(Resource):
    def put(self, user_id):
        args = parser.parse_args()
        USER_LIST[user_id] = {‘name‘: args[‘name‘]}
        return USER_LIST[user_id]

可以通过”parser.add_argument()”方法来定义form表单字段，并指定其类型（本例中是字符型str）。然后在PUT函数中，就可以调用”parser.parse_args()”来获取表单内容，并返回一个字典，该字典就包含了表单的内容。”parser.parse_args()”方法会自动验证数据类型，并在类型不匹配时，返回400错误。你还可以添加”strict”参数，如”parser.parse_args(strict=True)”，此时如果请求中出现未定义的参数，也会返回400错误。

示例代码

from flask import Flask
from flask_restful import Api, Resource, reqparse, abort
 
app = Flask(__name__)
api = Api(app)
 
USER_LIST = {
    1: {‘name‘:‘Michael‘},
    2: {‘name‘:‘Tom‘},
}
 
parser = reqparse.RequestParser()
parser.add_argument(‘name‘, type=str)
 
def abort_if_not_exist(user_id):
    if user_id not in USER_LIST:
        abort(404, message="User {} doesn‘t exist".format(user_id))
 
class User(Resource):
    def get(self, user_id):
        abort_if_not_exist(user_id)
        return USER_LIST[user_id]
 
    def delete(self, user_id):
        abort_if_not_exist(user_id)
        del USER_LIST[user_id]
        return ‘‘, 204
 
    def put(self, user_id):
        args = parser.parse_args(strict=True)
        USER_LIST[user_id] = {‘name‘: args[‘name‘]}
        return USER_LIST[user_id], 201
 
class UserList(Resource):
    def get(self):
        return USER_LIST
 
    def post(self):
        args = parser.parse_args(strict=True)
        user_id = int(max(USER_LIST.keys())) + 1
        USER_LIST[user_id] = {‘name‘: args[‘name‘]}
        return USER_LIST[user_id], 201
 
api.add_resource(UserList, ‘/users‘)
api.add_resource(User, ‘/users/<int:user_id>‘)
 
if __name__ == ‘__main__‘:
    app.run(host=‘0.0.0.0‘, debug=True)

flask-restful中装饰器的使用

参考技术AFlask-Restful的创建实例方法在这里定义的decorators是应用于所有的Resource的APIFlask-RESTful在扩展Flask-RESTful的使用提到这种使用场景。Flask-RESTful的装饰器可以用于许多场景，比如用户验证的场景或某些API需要特殊权限验证的... 查看详情

Flask-restful：将复杂对象编组为 json

】Flask-restful：将复杂对象编组为json【英文标题】：Flask-restful:marshalcomplexobjecttojson【发布时间】：2014-03-2823:04:35【问题描述】：我有一个关于烧瓶宁静扩展的问题。我刚开始使用它并面临一个问题。我有flask-sqlalchemy连接多对一... 查看详情

flask学习-23.restful接口开发(代码片段)

前言Flask-RESTful是一个Flask扩展，它添加了快速构建RESTAPIs的支持。它当然也是一个能够跟你现有的ORM/库协同工作的轻量级的扩展。Flask-RESTful鼓励以最小设置的最佳实践。如果你熟悉Flask的话，Flask-RESTful应该很容易上手。... 查看详情

flask-rest-前后端分离

项目：https://github.com/JulienBalestra/vue-flask创建restapi：https://github.com/flask-restful/flask-restful其他参考： https://www.cnblogs.com/vovlie/p/4178077.htmlhttps://blog.miguelgrinber 查看详情

Flask-RESTful - 上传图片

】Flask-RESTful-上传图片【英文标题】：Flask-RESTful-Uploadimage【发布时间】：2015-05-1300:39:35【问题描述】：我想知道如何通过创建API服务来上传文件？classUploadImage(Resource):defpost(self,fname):file=request.files[\'file\']iffile:#saveimageelse:#returnerro... 查看详情

Flask-RESTful - 返回自定义响应格式

】Flask-RESTful-返回自定义响应格式【英文标题】：Flask-RESTful-ReturncustomResponseformat【发布时间】：2013-12-1304:14:03【问题描述】：我已经根据Flask-RESTful文档定义了一个自定义响应格式，如下所示。app=Flask(__name__)api=restful.Api(app)@api.rep... 查看详情

Flask-restful：如何只响应附带的请求（'Accept'：'application/json'）？

】Flask-restful：如何只响应附带的请求（\\\'Accept\\\'：\\\'application/json\\\'）？【英文标题】：Flask-restful:Howtoonlyresponsetorequestscomewith(\'Accept\':\'application/json\')?Flask-restful：如何只响应附带的请求（\'Accept\'：\'application/json\'）？【发布... 查看详情

Flask (flask-restful) 和 MySQLdb (PyMySQL) 的奇怪并发问题

】Flask(flask-restful)和MySQLdb(PyMySQL)的奇怪并发问题【英文标题】：WeirdconcurrencyissuewithFlask(flask-restful)andMySQLdb(PyMySQL)【发布时间】：2021-09-1922:26:35【问题描述】：我有一个使用MySQL数据库的flask-restful项目，我目前正在使用PyMysql连接... 查看详情

flask-restful插件介绍--2017年4月7日

Flask-RESTful概述：为了快速构建RESTfulAPI的Flask插件，能和现有的ORM配合的轻量级数据抽象参考链接：http://www.pythondoc.com/Flask-RESTful/quickstart.htmlhttp://dormousehole.readthedocs.io/en/latest/可插拔视图资源路由:资源(Resources)是构建在Flask可拔插... 查看详情

flask-restful初探(代码片段)

flask-restful是Flask的一个用于支持RESTful的插件。刚开始用对我来说还是比较坑的。。。 目录结构/   /test   /test/common       /__init__.py   /test/reso 查看详情

使用 flask-restful RequestParser 进行嵌套验证

】使用flask-restfulRequestParser进行嵌套验证【英文标题】：Nestedvalidationwiththeflask-restfulRequestParser【发布时间】：2013-10-1414:39:27【问题描述】：使用flask-restful微框架，我无法构建将验证嵌套资源的RequestParser。假设表单的预期JSON资源... 查看详情

flask学习-40.flask-restful结合蓝图使用(代码片段)

前言Flask-RESTful结合蓝图使用设计接口RESTful接口没使用蓝图之前注册接口fromappsimportcreate_app,db,jwtfromflaskimporturl_for,request,jsonifyfromflask_restfulimportreqparse,abort,Api,Resourcefromapps.modelsimportUsersapp=cr 查看详情

Flask-Restful 中的中止方法忽略 CORS 选项

】Flask-Restful中的中止方法忽略CORS选项【英文标题】：abortmethodinFlask-RestfulignoringCORSoptions【发布时间】：2014-07-1905:20:08【问题描述】：我有一个配置了一些CORS选项的Flask-RestfulAPI：api=Api()api.decorators=[cors.crossdomain(origin=\'*\',headers=[\... 查看详情

Flask-Restful 优于 Flask-Restless

】Flask-Restful优于Flask-Restless【英文标题】：Flask-RestfulloverFlask-Restless【发布时间】：2013-10-1609:10:12【问题描述】：我是Python新手，正在探索Flask框架。我正在使用FlaskRestful开发一个简单的基于Rest的API。现在，我发现最大的挑战是... 查看详情

使用 flask-restful 时返回 text/html 内容类型

】使用flask-restful时返回text/html内容类型【英文标题】：returntext/htmlcontent-typewhenusingflask-restful【发布时间】：2014-12-1520:03:36【问题描述】：在特定情况下，我想使用text/html内容类型来响应错误，如下所示：classMyResource(Resource):defge... 查看详情

Flask-RESTful - 不返回对象属性而不是返回 null

】Flask-RESTful-不返回对象属性而不是返回null【英文标题】：Flask-RESTful-don\'treturnobjectpropertyinsteadofreturningnull【发布时间】：2015-05-2317:42:25【问题描述】：假设我有一个包含id、name和email字段的客户表。email字段是可选。代码如下所... 查看详情

Python Flask-Restful POST 不采用 JSON 参数

】PythonFlask-RestfulPOST不采用JSON参数【英文标题】：PythonFlask-RestfulPOSTnottakingJSONarguments【发布时间】：2015-08-1002:13:17【问题描述】：我对Flask（和Flask-Restful）非常陌生。我的问题：POST的json参数设置为NONE（不起作用）。我可以使用... 查看详情

python具有flask-restful的基本api服务器(代码片段)

查看详情