如何向使用 Flask 创建的 Python API 添加新参数

Question

我正在使用Flask 编写我的 Python API。此 API 仅接受 1 个名为 questionID 的参数。我希望它接受名为lastDate 的第二个参数。我试图四处寻找如何添加这个参数，但找不到一个好的方法来做到这一点。我当前的代码如下所示：

from flask import Flask, request
from flask_restful import Resource, Api, reqparse
from sqlalchemy import create_engine
from json import dumps
from flask_jsonpify import jsonify
import psycopg2
from pandas import read_sql
connenction_string = "DB Credentials'";

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

class GetUserAnswers(Resource):
    def get(self, questionID):
        conn = psycopg2.connect(connenction_string);
        cursor = conn.cursor();

        userAnswers = read_sql('''
        select * from <tablename> where questionid = ''' + "'" + questionID + "' order by timesansweredincorrectly desc limit 15" +'''
        ''', con=conn)

        conn.commit();
        conn.close();

        result = {}
        for index, row in userAnswers.iterrows():
            result[index] = dict(row)
        return jsonify(result)

api.add_resource(GetUserAnswers, '/GetUserAnswers/<questionID>')

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

问题 1： 我猜我可以接受 get 定义中的第二个参数。如果不是这样，我应该如何接受第二个参数？

问题2：如何修改api.add_resource()调用以接受第二个参数？

问题3：我目前使用http://localhost:5002/GetUserAnswers/<some question ID>从浏览器调用这个API。如果使用第二个参数，这个调用会如何变化？

我以前从未开发过 API，因此非常感谢任何帮助。

Answer 1

如果要在url路径中添加多个参数例如：

http://localhost:5002/GetUserAnswers/<question_id>/answers/<answer_id>

那么你需要给你的get方法添加多个参数：

def get(self, question_id, answer_id):
    # your code here

但是，如果您想在 url 中添加多个查询参数，例如： http://localhost:5002/GetUserAnswers/<question_id>?lastDate=2020-01-01&totalCount=10>

然后你可以使用请求参数：

def get(self, question_id):
    lastDate = request.args.get('lastDate')
    totalCount = request.args.get('totalCount')
    # your code here

Answer 2

考虑对您的代码进行一些调整：

1. 如需更简单的实现，请在 Flask API 中使用decorators，避免初始化和调用类对象；
2. 在 SQL 中使用parameterization，避免潜在的危险和混乱的字符串连接；
3. 避免使用繁重的数据分析库pandas 及其低效的逐行iterrows 循环。相反，使用光标对象处理所有内容，特别是在psycopg2 中使用DictCursor；

重构的 Python 代码（调整如何使用lastDate 的假设）：

#... leave out the heavy pandas ...

app = Flask(__name__)

@app.route('/GetUserAnswers', methods= ['GET'])
def GetUserAnswers():
    questionID = request.args.get('questionID', None)
    lastDate = request.args.get('lastDate', None)

    conn = psycopg2.connect(connenction_string)
    cur = conn.cursor(cursor_factory=psycopg2.extras.DictCursor)

    userAnswers = '''SELECT * FROM <tablename> 
                     WHERE questionid = %s
                       AND lastdate = %s
                     ORDER BY timesansweredincorrectly DESC
                     LIMIT 15
                 '''
    # EXECUTE SQL WITH PARAMS
    cur.execute(userAnswers, (questionID, lastDate))

    # SAVE TO LIST OF DICTIONARIES
    result = [dict(row) for row in cur.fetchall()]
    cur.close()
    conn.close()

    return jsonify(result)


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

浏览器调用

http://localhost:5002/GetUserAnswers?questionID=8888&lastDate=2020-01-08