Flask-RESTful是用于快速构建REST API的Flask扩展。我最近在使用Flask-Restful + Vue.js写一个轻量博客时有一个前端后端上传图片的需求。在Flask-Restful的官方文档中并没有相关的内容。下面是我谷歌查找资料的总结。
引入FileStorage
flask-restful
的参数解析中并没有文件类型,需要引入werkzeug.datastructures.FileStorage
作为参数解析中的类型。上传图片的资源api可以这样编写:
class UploadImg(Resource):def __init__(self):# 创建一个新的解析器self.parser = reqparse.RequestParser()# 增加imgFile参数,用来解析前端传来的图片。self.parser.add_argument('imgFile', required=True, type=FileStorage,location='files',help="imgFile is wrong.")def post(self):img_file = self.parser.parse_args().get('imgFile')# 保存图片img_file.save(img_file.filename)return 'ok', 201
FileStorage
这个类有很多的内置方法,这里使用了save
方法保存了图片,save
方法接受两个参数源码里面说明如下:dst
指定保存文件的name.
def save(self, dst, buffer_size=16384)::param dst: a filename, :class:`os.PathLike`, or open fileobject to write to.:param buffer_size: Passed as the ``length`` parameter of:func:`shutil.copyfileobj`.
完整代码
#!/usr/bin/env python
# encoding: utf-8
from flask_restful import reqparse, Resource, Api
from werkzeug.datastructures import FileStorage
from flask import Flaskclass UploadImg(Resource):def __init__(self):# 创建一个新的解析器self.parser = reqparse.RequestParser()# 增加imgFile参数,用来解析前端传来的图片。self.parser.add_argument('imgFile', required=True, type=FileStorage,location='files',help="imgFile is wrong.")def post(self):img_file = self.parser.parse_args().get('imgFile')img_file.save(img_file.filename)return 'ok', 201if __name__ == '__main__':app = Flask(__name__)api = Api(app)api.add_resource(UploadImg, '/uploadimg')app.run()