使用 Flask 构建 RESTful API 应用-JavaScript中文网-JavaScript教程资源分享门户

什么是 RESTful API？

RESTful API 是一种设计风格，用于创建可扩展的 Web 服务。它使用 Web 标准（如 HTTP、URI、JSON）来实现客户端和服务器之间的通信。RESTful API 的核心思想是资源，每个资源都有一个唯一的 URI（统一资源标识符），可以通过 HTTP 方法（如 GET、POST、PUT、DELETE）对其进行操作。

为什么使用 Flask？

Flask 是一个轻量级的 Web 框架，适用于构建小型 Web 应用和 RESTful API。它基于 Python 语言，具有简单易用的 API 和灵活的扩展性。使用 Flask 可以快速构建 RESTful API 应用，提高开发效率。

如何使用 Flask 构建 RESTful API 应用？

安装 Flask

首先需要安装 Flask。可以使用 pip 命令来安装：

pip install flask

创建 Flask 应用

接下来需要创建一个 Flask 应用。可以在 Python 文件中使用以下代码：

from flask import Flask

app = Flask(__name__)

@app.route("/")
def hello():
    return "Hello, World!"

这个应用会在根路径上返回 "Hello, World!"。

定义资源

在 RESTful API 中，每个资源都有一个唯一的 URI。可以使用 Flask 提供的 @app.route 装饰器来定义 URI。例如，可以定义一个 /users 资源：

// javascriptcn.com 代码示例
@app.route("/users")
def get_users():
    # 返回用户列表
    pass

@app.route("/users/<int:user_id>")
def get_user(user_id):
    # 返回指定用户
    pass

@app.route("/users", methods=["POST"])
def create_user():
    # 创建新用户
    pass

@app.route("/users/<int:user_id>", methods=["PUT"])
def update_user(user_id):
    # 更新指定用户
    pass

@app.route("/users/<int:user_id>", methods=["DELETE"])
def delete_user(user_id):
    # 删除指定用户
    pass

在上面的代码中，<int:user_id> 表示这个 URI 中的 user_id 参数是一个整数。可以在函数中使用这个参数来操作对应的用户。

处理请求和响应

在 Flask 中，可以使用 request 对象来处理请求，使用 make_response 函数来创建响应。例如，可以在 create_user 函数中创建一个新用户，并返回一个 JSON 格式的响应：

// javascriptcn.com 代码示例
from flask import request, jsonify

@app.route("/users", methods=["POST"])
def create_user():
    data = request.get_json()
    # 创建新用户
    user_id = create_new_user(data)
    # 返回新用户的信息
    user = get_user_by_id(user_id)
    response = jsonify(user)
    response.status_code = 201
    response.headers["Location"] = f"/users/{user_id}"
    return response

在上面的代码中，request.get_json() 可以获取请求中的 JSON 数据，jsonify 函数可以将 Python 对象转换成 JSON 格式的响应。

错误处理

在 RESTful API 中，错误处理非常重要。可以使用 Flask 提供的 @app.errorhandler 装饰器来处理错误。例如，可以定义一个处理 404 错误的函数：

@app.errorhandler(404)
def not_found_error(error):
    response = jsonify({"error": "Not found"})
    response.status_code = 404
    return response

在上面的代码中，jsonify 函数可以将 Python 字典转换成 JSON 格式的响应。

运行应用

最后需要运行 Flask 应用。可以在 Python 文件中使用以下代码：

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

这个应用会在本地启动一个 Web 服务器，并监听默认的 5000 端口。

示例代码

下面是一个完整的使用 Flask 构建 RESTful API 应用的示例代码：

// javascriptcn.com 代码示例
from flask import Flask, request, jsonify

app = Flask(__name__)

users = [
    {"id": 1, "name": "Alice"},
    {"id": 2, "name": "Bob"},
    {"id": 3, "name": "Charlie"},
]

def get_user_by_id(user_id):
    for user in users:
        if user["id"] == user_id:
            return user
    return None

def create_new_user(data):
    user_id = max(user["id"] for user in users) + 1
    user = {"id": user_id, "name": data["name"]}
    users.append(user)
    return user_id

@app.route("/")
def hello():
    return "Hello, World!"

@app.route("/users")
def get_users():
    return jsonify(users)

@app.route("/users/<int:user_id>")
def get_user(user_id):
    user = get_user_by_id(user_id)
    if user is None:
        return not_found_error(None)
    return jsonify(user)

@app.route("/users", methods=["POST"])
def create_user():
    data = request.get_json()
    if data.get("name") is None:
        response = jsonify({"error": "Name is required"})
        response.status_code = 400
        return response
    user_id = create_new_user(data)
    user = get_user_by_id(user_id)
    response = jsonify(user)
    response.status_code = 201
    response.headers["Location"] = f"/users/{user_id}"
    return response

@app.route("/users/<int:user_id>", methods=["PUT"])
def update_user(user_id):
    user = get_user_by_id(user_id)
    if user is None:
        return not_found_error(None)
    data = request.get_json()
    if data.get("name") is not None:
        user["name"] = data["name"]
    response = jsonify(user)
    response.status_code = 200
    return response

@app.route("/users/<int:user_id>", methods=["DELETE"])
def delete_user(user_id):
    user = get_user_by_id(user_id)
    if user is None:
        return not_found_error(None)
    users.remove(user)
    response = jsonify({"message": "User deleted"})
    response.status_code = 200
    return response

@app.errorhandler(404)
def not_found_error(error):
    response = jsonify({"error": "Not found"})
    response.status_code = 404
    return response

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

这个应用可以处理以下请求：

GET /users：返回用户列表
GET /users/1：返回 ID 为 1 的用户信息
POST /users：创建新用户
PUT /users/1：更新 ID 为 1 的用户信息
DELETE /users/1：删除 ID 为 1 的用户信息

总结

使用 Flask 可以快速构建 RESTful API 应用。需要定义资源、处理请求和响应、处理错误等。通过学习和实践，可以掌握 Flask 的使用方法，并在实际项目中应用。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/655ab18ed2f5e1655d4e885b