Flask-RESTful是flask的扩展,增加了对快速构建REST API的支持。Flask-RESTful通过最少的设置鼓励最佳的实践。
pip install flask-restful
Flask-RESTful需要Python版本2.7,3.4,3.5,3.6或3.7
- 资源和路由
from flask-restful import Resource,Api
app = Flask(name)
api = Api(app)
class TodoSimple(Resource):
pass
api.add_resource(TodoSimple, '/<string:todo_id>')
总结:
flask-restful的主要构建块是resource,资源构建在Flask可插入视图(http://flask.pocoo.org/docs/views/)之上,只需在资源上定义方法,即可轻松访问多个HTTP方法。
很多时候,在API中,您的资源会有多个网址。您可以将多个URL传递给Api对象add_resource()的方法上。每一个都将路由传到您的Resource
reqparse模块内置了对请求数据验证的支持 。
from flask_restful import reqparse
parser = reqparse.RequestParser()
parser.add_argument('rate', type=int, help='Rate to charge for this resource')
args = parser.parse_args()
注意:与argparse模块不同,reqparse.RequestParser.parse_args() 返回Python字典而不是自定义数据结构。
使用该reqparse模块还可以免费为您提供合理的错误消息。如果参数未能通过验证,Flask-RESTful将响应400 Bad Request和突出显示错误的响应。默认情况下,返回可迭代中的所有字段都将按原样呈现。虽然在处理Python数据结构时这很有用,但在处理对象时会非常令人沮丧。为了解决这个问题,Flask-RESTful提供了fields模块和 marshal_with()装饰器。与Django ORM和WTForm类似,您可以使用该fields模块来描述响应的结构。
from flask_restful import fields, marshal_with
@marshal_with
该 marshal_with()装饰将应用所描述的转变 resource_fields。从对象中提取的唯一字段是task。该 fields.Url字段是一个特殊字段,它采用端点名称并在响应中为该端点生成URL。您需要的许多字段类型已包含在内。