Flask使用Flask-RESTful传递参数给GET请求

在本文中，我们将介绍如何使用Flask-RESTful传递参数给GET请求。Flask-RESTful是一个基于Flask的扩展，它简化了构建RESTful API的过程，并提供了自动的路由和参数解析功能。

阅读更多：Flask 教程

1. 传递参数的方式

在Flask-RESTful中，我们可以通过URL的query参数、路径参数和请求体参数来传递参数给GET请求。

1.1 URL的query参数

URL的query参数是最常见的传递参数的方式，它将参数直接附加在URL的末尾，以?开头，多个参数之间用&分隔。

例如，如果我们有一个API接口/api/users，我们希望传递一个名为id的参数，可以使用如下URL：

GET /api/users?id=123

在Flask-RESTful中，我们可以通过request.args来获取URL的query参数：

from flask import request
from flask_restful import Resource

class UserResource(Resource):
    def get(self):
        id = request.args.get("id")
        # 处理参数
        return { "id": id }

1.2 路径参数

路径参数是将参数直接包含在URL的路径中，以冒号:开头，参数名为路径中的一部分。

例如，如果我们有一个API接口/api/users/<id>，我们希望传递一个名为id的参数，可以使用如下URL：

GET /api/users/123

在Flask-RESTful中，我们可以通过在路由装饰器中指定路径参数来获取参数值：

from flask_restful import Resource

class UserResource(Resource):
    def get(self, id):
        # 处理参数
        return { "id": id }

1.3 请求体参数

请求体参数是将参数放在请求的body中，以JSON格式传递给服务器。

例如，如果我们有一个API接口/api/users，我们希望传递一个名为id的参数，可以使用如下URL：

POST /api/users
Content-Type: application/json

{
    "id": 123
}

在Flask-RESTful中，我们可以通过request.get_json()来获取请求体参数：

from flask import request
from flask_restful import Resource

class UserResource(Resource):
    def post(self):
        data = request.get_json()
        id = data.get("id")
        # 处理参数
        return { "id": id }

2. 示例说明

下面我们通过一个具体的示例来说明如何使用Flask-RESTful传递参数给GET请求。

假设我们有一个用户管理系统，其中包含用户的增加和查询功能。我们可以使用Flask-RESTful来创建两个API接口，一个用于增加用户，另一个用于查询用户。

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

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

users = []

parser = reqparse.RequestParser()
parser.add_argument("id", type=int, help="User ID is required")
parser.add_argument("name", type=str, help="User Name is required")

class UserResource(Resource):
    def get(self):
        id = parser.parse_args()["id"]

        for user in users:
            if user["id"] == id:
                return user
        return { "message": f"User not found with id: {id}" }, 404

    def post(self):
        data = parser.parse_args()

        id = data["id"]
        name = data["name"]

        user = { "id": id, "name": name }
        users.append(user)

        return user, 201

api.add_resource(UserResource, "/api/users")

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

上述代码中，首先我们创建了一个UserResource类作为API接口的处理类。在get方法中，我们从URL的query参数中获取id参数，并根据该参数查询用户信息。在post方法中，我们从请求的body中获取id和name参数，并将用户信息添加到用户列表中。

然后，我们使用api.add_resource方法来注册UserResource类，并指定URL为/api/users。

最后，我们通过app.run方法运行Flask应用。

现在，我们可以使用POST请求来增加用户，使用GET请求来查询用户。