引言
在当今的互联网时代,RESTful API 已经成为构建分布式系统和服务端应用程序的标配。Flask 作为 Python 中最受欢迎的 Web 框架之一,以其轻量级、灵活性和易用性著称。本文将手把手教你如何使用 Flask 搭建一个简单的 RESTful API,并通过示例代码进行全解析。
环境准备
在开始之前,请确保你已经安装了 Python 和 Flask。以下是安装 Flask 的命令:
pip install flask
创建项目结构
首先,创建一个项目目录,并在其中创建以下文件和文件夹:
project/
│
├── app.py
├── requirements.txt
└── static/
在 requirements.txt 文件中,添加 Flask 的依赖项:
Flask==2.0.1
编写 Flask 应用
打开 app.py 文件,并按照以下示例代码进行编写:
from flask import Flask, jsonify, request
app = Flask(__name__)
# 数据库模拟
data = {
"users": [
{"id": 1, "name": "Alice", "age": 25},
{"id": 2, "name": "Bob", "age": 30},
{"id": 3, "name": "Charlie", "age": 35}
]
}
@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((item for item in data['users'] if item['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 = request.json
data['users'].append(user)
return jsonify(user), 201
@app.route('/users/<int:user_id>', methods=['PUT'])
def update_user(user_id):
user = next((item for item in data['users'] if item['id'] == user_id), None)
if user:
user.update(request.json)
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'] = [item for item in data['users'] if item['id'] != user_id]
return jsonify({"message": "User deleted"}), 200
if __name__ == '__main__':
app.run(debug=True)
运行 Flask 应用
在终端中,运行以下命令启动 Flask 应用:
python app.py
此时,Flask 应用将监听本地的 5000 端口。
测试 API
使用浏览器或 Postman 等工具,对以下 API 进行测试:
- 获取所有用户:
GET /users - 获取单个用户:
GET /users/1 - 创建用户:
POST /users(请求体:{"name": "David", "age": 40}) - 更新用户:
PUT /users/1(请求体:{"name": "David", "age": 45}) - 删除用户:
DELETE /users/1
总结
通过本文的示例代码,你学会了如何使用 Flask 搭建一个简单的 RESTful API。在实际项目中,你可以根据需求扩展 API 功能,例如添加数据库支持、认证机制等。希望本文能帮助你更好地掌握 Flask 和 RESTful API 的知识。
