Python flask-restful框架讲解

Flask-RESTful 是一个 Flask 扩展，它添加了快速构建 REST APIs 的支持。它当然也是一个能够跟你现有的ORM/库协同工作的轻量级的扩展。Flask-RESTful 鼓励以最小设置的最佳实践。如果你熟悉 Flask 的话，Flask-RESTful 应该很容易上手。
关于flask的使用，参考我的之前的博客：https://blog.csdn.net/shifengboy/article/details/114274271

flask-restful官方文档：https://flask-restful.readthedocs.io/en/lates
中文文档：http://www.pythondoc.com/Flask-RESTful/

flask-restful 安装

pip install flask-restful

flask-restful使用

简单上手

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class HelloWorld(Resource):
    def get(self):
        return {
   'hello': 'world'}

api.add_resource(HelloWorld, '/')

if __name__ == '__main__':
    app.run(debug=True)

运行结果：

$ curl http://127.0.0.1:5000/
{
   "hello": "world"}

Resourceful 路由

Flask-RESTful 提供的主要构建块是资源。资源构建在 Flask 可插入视图之上，只需在资源上定义方法，就可以轻松访问多个 HTTP 方法。一个 todo 应用程序的基本 CRUD 资源是这样的:

from flask import Flask, request
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

todos = {
   }

class TodoSimple(Resource):
    def get(self, todo_id):
        return {
   todo_id: todos[todo_id]}

    def put(self, todo_id):
        todos[todo_id] = request.form['data']
        return {
   todo_id: todos[todo_id]}

api.add_resource(TodoSimple, '/<string:todo_id>')

if __name__ == '__main__':
    app.run(debug=True)

运行结果：

chenshifengdeMacBook-Pro:~ chenshifeng$ curl http://localhost:5000/todo1 -d "data=Remember the milk" -X PUT
{
   
    "todo1": "Remember the milk"
}
chenshifengdeMacBook-Pro:~ chenshifeng$ curl http://localhost:5000/todo1
{
   
    "todo1": "Remember the milk"
}
chenshifengdeMacBook-Pro:~ chenshifeng$ curl http://localhost:5000/todo2 -d "data=Change my brakepads" -X PUT
{
   
    "todo2": "Change my brakepads"
}
chenshifengdeMacBook-Pro:~ chenshifeng$ curl http://localhost:5000/todo2
{
   
    "todo2": "Change my brakepads"
}
chenshifengdeMacBook-Pro:~ chenshifeng$ 

Restful 能够从 view 方法中理解多种返回值。类似于 Flask，你可以返回任何可迭代的并且它将被转换成一个响应，包括原始 Flask 响应对象。还支持使用多个返回值设置响应代码和响应头，如下所示:

#!/usr/bin/python
# -*- coding: UTF-8 -*-
"""
@author:chenshifeng
@file:flask_restful_demo.py
@time:2021/03/05
"""
from flask import Flask, request
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class Todo1(Resource):
    def get(self):
        # Default to 200 OK
        return {
   'task': 'Hello world'}