正文

从零开始：用Flask框架轻松搭建RESTful API教程

/0 浏览量
0530

引言

在互联网时代，RESTful API成为了构建现代Web服务的重要方式。Flask，作为Python中一个轻量级的Web框架，因其简单易用而受到许多开发者的喜爱。本文将带你从零开始，学习如何使用Flask框架搭建一个简单的RESTful API。

准备工作

在开始之前，请确保你的计算机上已安装以下工具：

  • Python 3.x
  • Flask
  • requests（用于测试API）

你可以使用pip来安装Flask和requests：

pip install Flask requests

第一步：创建项目结构

创建一个名为my_api的文件夹，并在其中创建以下文件：

  • app.py：Flask应用的主文件。
  • requirements.txt：记录项目依赖。

第二步：编写Flask应用

打开app.py，编写以下代码：

from flask import Flask, jsonify, request

app = Flask(__name__)

# 数据库模拟
data = {
    "users": [
        {"id": 1, "name": "Alice"},
        {"id": 2, "name": "Bob"},
        {"id": 3, "name": "Charlie"}
    ]
}

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

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

@app.route('/users', methods=['POST'])
def create_user():
    user = {
        "id": len(data['users']) + 1,
        "name": request.json['name']
    }
    data['users'].append(user)
    return jsonify(user), 201

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

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

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

这段代码定义了一个简单的RESTful API，包括以下功能：

  • 获取所有用户
  • 获取单个用户
  • 创建新用户
  • 更新用户信息
  • 删除用户

第三步：测试API

使用requests库测试API：

import requests

# 获取所有用户
response = requests.get('http://localhost:5000/users')
print(response.json())

# 获取单个用户
response = requests.get('http://localhost:5000/users/1')
print(response.json())

# 创建新用户
response = requests.post('http://localhost:5000/users', json={"name": "David"})
print(response.json())

# 更新用户信息
response = requests.put('http://localhost:5000/users/4', json={"name": "Eve"})
print(response.json())

# 删除用户
response = requests.delete('http://localhost:5000/users/3')
print(response.json())

以上代码展示了如何使用requests库测试Flask API。

总结

通过本文的学习，你现在已经可以使用Flask框架搭建一个简单的RESTful API了。随着你对Flask和RESTful API的深入了解，你可以在此基础上不断扩展和优化你的API。祝你编程愉快！

-- 展开阅读全文 --