使用Python搭建简易RESTful API

在当今的互联网时代，RESTful API已成为前后端分离架构中的核心组件。通过Python，我们可以轻松创建一个简易的RESTful API，本文将带你一步步实现这一过程。

准备工作

首先，确保你已经安装了Python环境。接下来，我们将使用Flask框架来构建API，因为它简单易用且功能强大。

pip install Flask

创建基础框架

创建一个新的Python文件，例如app.py，并导入Flask模块：

from flask import Flask, jsonify, request

app = Flask(__name__)

@app.route('/')
def home():
    return "Welcome to our RESTful API!"

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

运行app.py，打开浏览器访问http://127.0.0.1:5000/，你应该能看到“Welcome to our RESTful API!”的欢迎信息。

定义数据结构

假设我们要管理一个简单的用户信息系统，首先定义一些初始数据：

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

创建API端点

获取所有用户

@app.route('/users', methods=['GET'])
def get_users():
    return jsonify(users)

访问http://127.0.0.1:5000/users，你将看到所有用户的信息。

获取单个用户

@app.route('/users/<int:user_id>', methods=['GET'])
def get_user(user_id):
    user = next((user for user in users if user['id'] == user_id), None)
    if user:
        return jsonify(user)
    else:
        return jsonify({"error": "User not found"}), 404

访问http://127.0.0.1:5000/users/1，你将看到ID为1的用户信息。

创建新用户

@app.route('/users', methods=['POST'])
def create_user():
    data = request.get_json()
    if not data or 'name' not in data or 'age' not in data:
        return jsonify({"error": "Missing name or age"}), 400

    new_user = {
        "id": len(users) + 1,
        "name": data['name'],
        "age": data['age']
    }
    users.append(new_user)
    return jsonify(new_user), 201

使用POST请求发送JSON数据到http://127.0.0.1:5000/users，例如：

{
    "name": "David",
    "age": 40
}

更新用户信息

@app.route('/users/<int:user_id>', methods=['PUT'])
def update_user(user_id):
    user = next((user for user in users if user['id'] == user_id), None)
    if not user:
        return jsonify({"error": "User not found"}), 404

    data = request.get_json()
    user['name'] = data.get('name', user['name'])
    user['age'] = data.get('age', user['age'])
    return jsonify(user)

使用PUT请求发送更新数据到http://127.0.0.1:5000/users/1，例如：

{
    "name": "Alice Updated",
    "age": 26
}

删除用户

@app.route('/users/<int:user_id>', methods=['DELETE'])
def delete_user(user_id):
    global users
    users = [user for user in users if user['id'] != user_id]
    return jsonify({"message": "User deleted"})

使用DELETE请求访问http://127.0.0.1:5000/users/1，ID为1的用户将被删除。