Python Flask之RESTful讲解与示例演示(3)

Python

3）RESTful 示例讲解

下面是一个简单的 Flask RESTful API 示例，它实现了一个简单的 To-Do List 应用程序：

from flask import Flask, request
from flask_restful import Api, Resource, reqparse, fields, marshal_with
app = Flask(__name__)
api = Api(app)
todos = {}
todo_fields = {
    'id': fields.Integer,
    'task': fields.String,
    'status': fields.Boolean
}
class TodoList(Resource):
    @marshal_with(todo_fields)
    def get(self):
        return todos
    @marshal_with(todo_fields)
    def post(self):
        parser = reqparse.RequestParser()
        parser.add_argument('task', type=str, help='Task is required', required=True)
        args = parser.parse_args()
        todo_id = len(todos) + 1
        todo = {'task': args['task'], 'status': False}
        todos[todo_id] = todo
        return todo, 201
class TodoItem(Resource):
    @marshal_with(todo_fields)
    def get(self, todo_id):
        return todos[todo_id]
    def put(self, todo_id):
        parser = reqparse.RequestParser()
        parser.add_argument('task', type=str)
        parser.add_argument('status', type=bool)
        args = parser.parse_args()
        todo = todos[todo_id]
        if args['task']:
            todo['task'] = args['task']
        if args['status']:
            todo['status'] = args['status']
        return todo
    def delete(self, todo_id):
        del todos[todo_id]
        return '', 204
api.add_resource(TodoList, '/todos')
api.add_resource(TodoItem, '/todos/<int:todo_id>')
if __name__ == '__main__':
    app.run(debug=True)

启动

# 配置环境变量
export FLASK_APP=restful-test.py
# 启动服务，公开访问需要加上--host=0.0.0.0
python -m flask run --host=0.0.0.0

该示例使用 Flask 和 Flask-RESTful 库来实现 To-Do List 应用程序的 RESTful API。下面是一些重要的代码片段的解释：

1. 定义资源：在示例中，有两个资源：TodoList和TodoItem。TodoList用于处理所有的 To-Do 任务列表，TodoItem用于处理单个任务。
2. 定义请求参数：在示例中，我们使用 Flask-RESTful 库的 RequestParser 来解析请求参数。我们定义了‘task’和‘status’参数，并使用add_argument()方法来指定它们的类型和其他限制条件。
3. 定义响应格式：在示例中，我们使用 Flask-RESTful 库的marshal_with()装饰器来定义响应的格式。我们定义了一个名为todo_fields的字典，其中包含了 To-Do 任务的id、task和status字段。
4. 定义请求方法：在示例中，我们使用 Flask-RESTful 库的 Resource 类来定义请求方法。我们实现了GET、POST、PUT和DELETE方法，用于获取任务列表、添加任务、更新任务和删除任务。
5. 添加路由：在示例中，我们使用 Flask-RESTful 库的 Api 类来添加路由。我们使用add_resource()方法来将 TodoList 和 TodoItem 类与相应的 URL 路由绑定起来。
   上一页1234下一页