Flask API无法从URL传递关键字参数问题排查及示例求助

一、普通Flask核心实现 #

直接利用Flask内置的request.args对象即可获取URL中的查询参数，以下是可行示例：

from flask import Flask, request

app = Flask(__name__)

@app.route('/duck')
def duck_handler():
    # 获取单个参数，指定默认值与类型转换
    order = request.args.get('order', default=20, type=int)
    # 获取所有查询参数并转为普通字典
    all_query_params = request.args.to_dict()
    
    return {
        'received_order': order,
        'all_params': all_query_params
    }

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

测试访问http://localhost:5000/duck?order=90&color=yellow，会返回：

{"received_order":90,"all_params":{"order":"90","color":"yellow"}}

二、Flask-RESTful正确写法 #

如果用Flask-RESTful，需正确使用reqparse解析参数，避免参数未生效问题：

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

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

class DuckResource(Resource):
    def get(self):
        # 初始化参数解析器
        parser = reqparse.RequestParser()
        # 添加参数规则：可选参数，默认值20，类型为整数
        parser.add_argument('order', type=int, required=False, default=20)
        # 可按需添加任意多个参数规则
        parser.add_argument('name', type=str, required=False)
        # 执行参数解析，得到参数字典
        args = parser.parse_args()
        
        return {
            'order': args['order'],
            'name': args['name']
        }

api.add_resource(DuckResource, '/duck')

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

三、常见问题排查 #

• 混淆路由参数与查询参数：如果你的路由写为@app.route('/duck/<order>')，这是路径参数，访问方式是/duck/90，而非带?的查询参数，与需求不符。
• 参数名大小写不匹配：URL中传的是Order=90，但代码里取的是order，Flask参数名区分大小写，会导致取到默认值。
• Flask-RESTful未调用parse_args()：仅定义reqparse规则但不执行解析，会导致始终用默认值。
• 类型转换失败未处理：如果传的是order=abc但指定了type=int，Flask-RESTful会返回400错误，若你未捕获错误，可能误以为参数未传递。

内容的提问来源于stack exchange，提问作者Ujhazi