Flask-Restful插件
介绍：
今天跟大家介绍一下flask中一个插件——Flask-Restful！Flask-Restful是一个专门用来写restful api的一个插件。使用他可以快速的集成restful api功能。在app的后台以及纯api的后台中，这个插件可以帮助我们节省很多时间。当然，如果在普通的网站中，这个插件就显得有些鸡肋了，因为在普通的网页开发中，是需要去渲染HTML代码的，而Flask-Restful在每个请求中都是返回json格式的数据。
安装：
Flask-Restful需要在Flask 0.8以上的版本，在Python2.6或者Python3.3上运行。通过pip install flask-restful即可安装。
定义Restful的视图：
如果使用Flask-Restful，那么定义视图函数的时候，就要继承自flask_restful.Resource类，然后再根据当前请求的method来定义相应的方法。比如期望客户端是使用get方法发送过来的请求，那么就定义一个get方法。类似于MethodView。示例代码如下：
from flask import Flask,render_template,url_for
from flask_restful import Api,Resource
app = Flask(__name__)
# 用Api来绑定app
api = Api(app)
class IndexView(Resource):
def get(self):
return {"username":"qf"}
api.add_resource(IndexView,'/',endpoint='index')注意事项：
-
endpoint是用来给url_for反转url的时候指定的。如果不写endpoint，那么将会使用视图的名字的小写来作为endpoint。 -
add_resource的第二个参数是访问这个视图函数的url，这个url可以跟之前的route一样，可以传递参数。并且还有一点不同的是，这个方法可以传递多个url来指定这个视图函数。
参数解析：
Flask-Restful插件提供了类似WTForms来验证提交的数据是否合法的包，叫做reqparse。以下是基本用法：
parser = reqparse.RequestParser()
parser.add_argument('username',type=str,help='请输入用户名')
args = parser.parse_args()add_argument可以指定这个字段的名字，这个字段的数据类型等。以下将对这个方法的一些参数做详细讲解：
-
default：默认值，如果这个参数没有值，那么将使用这个参数指定的值。 -
required：是否必须。默认为False，如果设置为True，那么这个参数就必须提交上来。 -
type：这个参数的数据类型，如果指定，那么将使用指定的数据类型来强制转换提交上来的值。 -
choices：选项。提交上来的值只有满足这个选项中的值才符合验证通过，否则验证不通过。 -
help：错误信息。如果验证失败后，将会使用这个参数指定的值作为错误信息。 -
trim：是否要去掉前后的空格。
其中的type，可以使用python自带的一些数据类型，也可以使用flask_restful.inputs下的一些特定的数据类型来强制转换。比如一些常用的：
-
url：会判断这个参数的值是否是一个url，如果不是，那么就会抛出异常。 -
regex：正则表达式。 -
date：将这个字符串转换为datetime.date数据类型。如果转换不成功，则会抛出一个异常。
输出字段：
对于一个视图函数，你可以指定好一些字段用于返回。以后可以使用ORM模型或者自定义的模型的时候，他会自动的获取模型中的相应的字段，生成json数据，然后再返回给客户端。这其中需要导入flask_restful.marshal_with装饰器。并且需要写一个字典，来指示需要返回的字段，以及该字段的数据类型。示例代码如下：
class ProfileView(Resource):
resource_fields = {
'username': fields.String,
'age': fields.Integer,
'school': fields.String
}
@marshal_with(resource_fields)
def get(self,user_id):
user = User.query.get(user_id)
return user在get方法中，返回user的时候，flask_restful会自动的读取user模型上的username以及age还有school属性。组装成一个json格式的字符串返回给客户端。
无论在工作中还是学习中，都会用到许多接口，学会flask-restful，就可以自己写接口啦，你学废了嘛！
