Flask restful 分页

Question

我需要在很短的期限内完成一个非常简单的 API。 Flask-restful 看起来很理想，除了一件事：我在文档中找不到任何关于分页的内容。给定一个像这样的简单端点：

from flask import Flask, request 
from flask_restful import Resource, Api 
from sqlalchemy import create_engine
import json 

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

class Employees(Resource):
    def get(self):
        return json.dumps([{'employees': 'hello world'} for i in range(1000)])

api.add_resource(Employees, '/employees')

if __name__ == '__main__':
    app.run(port='5002')

有什么方法可以让 flask_restful 对端点进行分页，这样我每页只收到 100 个这样的词典，并且有 'next' 和 'previous' 的 URL？如果没有，是否可以在 Flask 中以其他方式创建分页？谢谢

Answer 1

您可以使用：

分页由 flask_sqlalchemy (API documentation can be found here)
对现有数据进行分页的自定义方法 in this tutorial by Avi Aryan。

由于我不确定您是否使用 flask_sqlalchemy 或任何模型信息，我将展示自定义分页技术。

我已修改数据以显示员工 ID。我还使用了 Flask 中的 jsonify。

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


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

data = [{'employee_id': i+1} for i in range(1000)]

def get_paginated_list(results, url, start, limit):
    start = int(start)
    limit = int(limit)
    count = len(results)
    if count < start or limit < 0:
        abort(404)
    # make response
    obj = {}
    obj['start'] = start
    obj['limit'] = limit
    obj['count'] = count
    # make URLs
    # make previous url
    if start == 1:
        obj['previous'] = ''
    else:
        start_copy = max(1, start - limit)
        limit_copy = start - 1
        obj['previous'] = url + '?start=%d&limit=%d' % (start_copy, limit_copy)
    # make next url
    if start + limit > count:
        obj['next'] = ''
    else:
        start_copy = start + limit
        obj['next'] = url + '?start=%d&limit=%d' % (start_copy, limit)
    # finally extract result according to bounds
    obj['results'] = results[(start - 1):(start - 1 + limit)]
    return obj

class Employees(Resource):
    def get(self):
        return jsonify(get_paginated_list(
        data, 
        '/employees', 
        start=request.args.get('start', 1), 
        limit=request.args.get('limit', 20)
    ))

api.add_resource(Employees, '/employees')

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

输出：

脚注：

API可以带参数调用，也可以不带参数调用。有效 API 调用示例：
- http://127.0.0.1:5002/employees
- http://127.0.0.1:5002/employees?start=41&limit=20
- http://127.0.0.1:5002/employees?limit=5
- http://127.0.0.1:5002/employees?start=100
start 的默认值为 1，limit 的默认值为 20。
如果 start 值大于数据长度或限制为负数，则 API 将 return HTTP 404 错误并显示错误消息：

Flask restful 分页

Flask restful pagination

python

flask

flask-restful