安装:pip install flask-restful
如果使用Flask-restful,那么定义视图函数的时候,就要继承flask_restful.Resourse类,然后再根据当前请求的method来定义相应的方法。比如期望客户端是使用get方法发送过来的请求,那么就定义一个get方法。
from flask import Flask
from flask_restful import Api,Resource
app = Flask(__name__)
api = Api(app) #用Api来绑定app
class LoginView(Resource):
def post(self):
return {'username':'derek'}
api.add_resource(LoginView,'/login/',endpoint="login")
@app.route('/')
def index():
return 'Hello World!'
if __name__ == '__main__':
app.run(debug=True)
说明:
Flask-Restful插件提供了类似WTForms来验证提交的数据是否合法的包,叫做reqparse。
from flask import Flask
from flask_restful import Api,Resource,reqparse,inputs
app = Flask(__name__)
api = Api(app)
class LoginView(Resource):
def post(self):
parser = reqparse.RequestParser()
parser.add_argument('username',type=str,help='用户名验证错误',default='xxx',trim=True)
parser.add_argument('password',type=str,help='密码验证错误',required=True)
parser.add_argument('gender',type=str,choices=['male','famale'])
parser.add_argument('home_page',type=inputs.url,help=('个人中心链接错误'))
parser.add_argument('birthday',type=inputs.date)
args = parser.parse_args()
print(args)
return {'username':'derek'}
api.add_resource(LoginView,'/login/',endpoint="login")
@app.route('/')
def index():
return 'Hello World!'
if __name__ == '__main__':
app.run(debug=True)
参数说明:
其中的type,可以使用python自带的一些数据类型,也可以使用flask_restful.inputs下的一些特定的数据类型来强制转换。比如一些常用的:
输出字段
对于一个视图函数,你可以指定好一些字段用于返回。以后可以使用orm模型或者自定义的模型的时候,它会自动的获取模型的相应的字段,生成json数据,然后再返回给客户端。这其中需要导入flask_restful.marshal_with装饰器。并且需要些一个字典,来指示需要返回的字段,以及该字段的数据类型。
简单实例:
from flask_restful import Resource,fields,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属性。组成一个json格式的字符串返回给客户端。
重命名属性
很多时候你面向公众的字段名称是不同于内部的属性名,使用attribute可以配置这种映射。比如现在想要返回user.sckool的值,但是在返回给外面的时候,想以education返回回去,那么可以这样写:
resource_fields = {
'username':fields.String,
'age':fields.String
'education':fields.String(attribute='school') #重命名属性
}
默认值
在返回一些字段的时候,有时候可能没有值,那么这时候可以指定fields的时候给定一个默认值。
resource_fields = {
'username':fields.String,
'age':fields.Integer(default=18), # 默认值
'education':fields.String(attribute='school')
}
复杂结构
有时候想要在返回的数据格式中,形参比较复杂的结构。那么可以使用一些特殊的字段来实现。比如要在一个字段中防止一个列表,那么可以使用fields.list;比如在一个字段下面又是一个字典,那么可以使用fields.Nested.
简单实例:
resource_fields = {
'username':fields.String,
'age':fields.Integer(default=18), # 默认值
'education':fields.String(attribute='school'), #重命名属性
'tags':fields.List(fields.String),
'more':fields.Nested({
'signature':fields.String
})
}