Flask RESTful API 教程:从零实现 Python CRUD 后端服务
在现代 Web 开发中,RESTful API 是后端与前端通信的核心方式。本文将带你从零开始使用 Python Flask 构建 RESTful API,并实现完整的 CRUD(创建 Create、读取 Read、更新 Update、删除 Delete)操作。本文内容涵盖环境搭建、路由设计、数据库操作及示例代码,帮助开发者快速掌握后端开发核心技能。
一. 环境准备
在开始编写 Flask RESTful API 之前,需要确保本地开发环境配置正确。
1. 安装 Python
确保系统已安装 Python 3.8+,可通过命令检查:
python --version
如果未安装,请前往 Python 官方网站 下载并安装。
2. 创建虚拟环境
推荐使用虚拟环境隔离项目依赖:
python -m venv venv
source venv/bin/activate # Linux/Mac
venv\Scripts\activate # Windows
3. 安装 Flask 及相关依赖
使用 pip 安装 Flask 和 Flask-RESTful:
pip install Flask Flask-RESTful
如果需要数据库支持,可以安装 SQLite 或 SQLAlchemy:
pip install Flask-SQLAlchemy
二. 创建 Flask 项目结构
一个标准的 Flask RESTful API 项目结构示例如下:
flask_crud_api/
│
├─ app.py # 主应用文件
├─ models.py # 数据库模型
├─ resources.py # API 资源与路由
├─ requirements.txt # 项目依赖
└─ config.py # 配置文件
这种结构清晰、可维护,便于后期扩展。
三. 定义数据库模型
在 models.py
中定义一个简单的用户模型(User):
from flask_sqlalchemy import SQLAlchemydb = SQLAlchemy()class User(db.Model):id = db.Column(db.Integer, primary_key=True)name = db.Column(db.String(50), nullable=False)email = db.Column(db.String(100), unique=True, nullable=False)def to_dict(self):return {'id': self.id,'name': self.name,'email': self.email}
四. 编写 API 路由与资源
在 resources.py
中创建 RESTful API 路由,实现 CRUD 操作:
from flask import Flask, request, jsonify
from flask_restful import Api, Resource
from models import db, Userapp = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///users.db'
db.init_app(app)api = Api(app)class UserResource(Resource):def get(self, user_id=None):if user_id:user = User.query.get(user_id)return user.to_dict() if user else {'message': 'User not found'}, 404users = User.query.all()return [user.to_dict() for user in users]def post(self):data = request.get_json()user = User(name=data['name'], email=data['email'])db.session.add(user)db.session.commit()return user.to_dict(), 201def put(self, user_id):data = request.get_json()user = User.query.get(user_id)if not user:return {'message': 'User not found'}, 404user.name = data.get('name', user.name)user.email = data.get('email', user.email)db.session.commit()return user.to_dict()def delete(self, user_id):user = User.query.get(user_id)if not user:return {'message': 'User not found'}, 404db.session.delete(user)db.session.commit()return {'message': 'User deleted'}api.add_resource(UserResource, '/users', '/users/<int:user_id>')if __name__ == '__main__':with app.app_context():db.create_all()app.run(debug=True)
五. 测试 API
使用 Postman 或 curl 测试 API:
- 创建用户:
curl -X POST http://127.0.0.1:5000/users -H "Content-Type: application/json" -d '{"name":"Alice","email":"alice@example.com"}'
- 查询所有用户:
curl http://127.0.0.1:5000/users
- 查询单个用户:
curl http://127.0.0.1:5000/users/1
- 更新用户信息:
curl -X PUT http://127.0.0.1:5000/users/1 -H "Content-Type: application/json" -d '{"name":"Alice Smith"}'
- 删除用户:
curl -X DELETE http://127.0.0.1:5000/users/1
六. 总结与最佳实践
- Flask 适合快速搭建 RESTful API,轻量且易扩展。
- CRUD 操作是后端开发核心技能,掌握数据增删改查有助于开发复杂业务逻辑。
- 项目结构清晰、模块化设计便于维护和团队协作。
- 可以结合 Flask-RESTful、Flask-SQLAlchemy 和 Marshmallow 实现更完善的 API 设计和数据验证。
通过本文教程,开发者可以从零开始搭建 Python Flask 后端服务,并实现完整的 CRUD 功能,为实际项目开发打下坚实基础。
更多详情可查看 Python Flask 教程:从零构建 RESTful API 并实现 CRUD 操作