如何使用 Flask 和 Python 创建 RESTful API
在现代 Web 开发中，RESTful API 已经成为了前后端通信的标准方式之一。Python 作为一种高效、简洁的编程语言，配合轻量级的 Web 框架 Flask，可以非常快速地构建出强大的 RESTful API。本文将带你从零开始，一步步使用 Flask 创建一个完整的 CRUD（创建、读取、更新、删除）API。
一、环境准备
在开始编写代码之前，你需要确保系统中已经安装了 Python。建议使用虚拟环境来隔离项目的依赖。
首先，创建一个项目文件夹并进入该目录，然后执行以下命令：
# 创建虚拟环境 python -m venv venv # 激活虚拟环境 # 激活虚拟环境 venvScriptsactivate # 安装 Flask pip install Flask
二、创建基础的 Flask 应用
在项目目录下创建一个名为 app.py 的文件，我们将在这个文件中编写所有的代码。首先，我们来创建一个最简单的 Flask 应用，并定义一个根路由。
from flask import Flask, jsonify, request
app = Flask(__name__)
@app.route('/', methods=['GET'])
def home():
return jsonify({"message": "Welcome to the Flask RESTful API!"})
if __name__ == '__main__':
app.run(debug=True)在终端中运行 python app.py，服务器将在 http://127.0.0.1:5000/ 上启动。访问该地址，你将看到返回的 JSON 响应。
三、实现 CRUD 操作
为了演示 RESTful API 的核心功能，我们将创建一个简单的“任务管理”API。由于本文重点在于 API 的构建，我们将使用一个内存中的 Python 列表来模拟数据库。
在 app.py 的顶部添加模拟数据：
tasks = [
{
'id': 1,
'title': 'Learn Python',
'description': 'Learn the basics of Python programming',
'done': False
},
{
'id': 2,
'title': 'Learn Flask',
'description': 'Learn how to create RESTful APIs with Flask',
'done': False
}
]1. 获取所有任务 (GET)
我们需要一个路由来返回所有的任务列表。
@app.route('/api/tasks', methods=['GET'])
def get_tasks():
return jsonify({'tasks': tasks})2. 获取单个任务 (GET)
通过任务 ID 获取特定的任务。如果任务不存在，返回 404 错误。
@app.route('/api/tasks/', methods=['GET'])
def get_task(task_id):
task = next((task for task in tasks if task['id'] == task_id), None)
if task is None:
return jsonify({'error': 'Task not found'}), 404
return jsonify({'task': task})3. 创建新任务 (POST)
客户端可以通过 POST 请求提交 JSON 数据来创建新任务。我们需要对请求的数据进行简单的验证。
@app.route('/api/tasks', methods=['POST'])
def create_task():
if not request.json or not 'title' in request.json:
return jsonify({'error': 'Bad request, title is required'}), 400
new_task = {
'id': tasks[-1]['id'] + 1 if len(tasks) > 0 else 1,
'title': request.json['title'],
'description': request.json.get('description', ""),
'done': False
}
tasks.append(new_task)
return jsonify({'task': new_task}), 2014. 更新现有任务 (PUT)
通过任务 ID 更新任务的部分信息。
@app.route('/api/tasks/', methods=['PUT'])
def update_task(task_id):
task = next((task for task in tasks if task['id'] == task_id), None)
if task is None:
return jsonify({'error': 'Task not found'}), 404
if not request.json:
return jsonify({'error': 'Bad request'}), 400
task['title'] = request.json.get('title', task['title'])
task['description'] = request.json.get('description', task['description'])
task['done'] = request.json.get('done', task['done'])
return jsonify({'task': task})5. 删除任务 (DELETE)
通过任务 ID 删除指定的任务。
@app.route('/api/tasks/', methods=['DELETE'])
def delete_task(task_id):
global tasks
task = next((task for task in tasks if task['id'] == task_id), None)
if task is None:
return jsonify({'error': 'Task not found'}), 404
tasks = [task for task in tasks if task['id'] != task_id]
return jsonify({'result': 'Task deleted successfully'}), 200四、测试 API
你可以使用 Postman、Insomnia 或者 curl 等工具来测试我们刚刚创建的 API。以下是一些 curl 测试示例：
获取所有任务：
curl -i http://www.ipipp.com:5000/api/tasks
创建新任务：
curl -i -H "Content-Type: application/json" -X POST -d '{"title":"Read a book"}' http://www.ipipp.com:5000/api/tasks更新任务：
curl -i -H "Content-Type: application/json" -X PUT -d '{"done":true}' http://www.ipipp.com:5000/api/tasks/3删除任务：
curl -i -X DELETE http://www.ipipp.com:5000/api/tasks/2
五、总结
通过以上步骤，我们已经成功使用 Flask 和 Python 构建了一个功能完整的 RESTful API。这个 API 支持基本的 CRUD 操作，并遵循了 REST 的设计原则：使用标准的 HTTP 方法（GET, POST, PUT, DELETE）来操作资源，并返回合适的 HTTP 状态码。
虽然我们在本文中使用了内存列表来存储数据，但在实际的生产环境中，你需要将数据持久化到数据库中（如 MySQL、PostgreSQL 或 MongoDB）。你可以借助 Flask-SQLAlchemy 或 Flask-MongoEngine 等扩展轻松实现数据库的集成。希望这篇文章能帮助你快速入门 Flask API 的开发！