Python Flask 轻量级 Web 框架的基础用法及 HTTP 微服务开发流程。内容涵盖 Flask 环境安装与验证、GET 与 POST 接口的实现（包括路径参数、查询参数、JSON 及表单数据处理）、以及基于 SQLAlchemy 的 SQLite 数据库集成。教程详细演示了用户资源的 CRUD 操作，包括创建、查询列表、查询详情、搜索、更新和删除功能，并结合 Postman 工具进行了接口测试说明。文章旨在帮助开发者快速掌握 Flask 构建 RESTful API 的核心技能。
Flask 是一个轻量级的 Python Web 框架，以其'微内核'设计哲学闻名。所谓'微'并非指功能简单，而是指核心简洁、高度可扩展——Flask 只提供最基础的 Web 服务能力，其他所有功能都可通过丰富的扩展生态系统按需添加。这种设计让开发者能够从几行代码的简单应用开始，逐步构建出复杂的企业级系统。
首先确保已安装 Python（建议版本 3.7+），然后通过 pip 安装 Flask 依赖：
# 安装 Flask
pip install flask
# 如果系统中有多个 Python 版本，可能需要使用 pip3
pip3 install flask
安装完成后，创建一个简单的应用来验证 Flask 是否正确安装并正常工作：
# main.py
from flask import Flask
app = Flask(__name__)
@app.route('/', methods=['GET'])
def hello():
"""
处理根路径 GET 请求的处理函数
当用户访问网站根路径时，此函数会被调用
"""
return "Flask 安装成功！"
if __name__ == '__main__':
# 运行 Flask 应用程序
# debug=True 表示开启调试模式：
# 1. 代码修改后服务器会自动重启
# 2. 发生错误时浏览器会显示详细错误信息
# 3. 仅用于开发环境，生产环境应设置为 False
app.run(debug=True)
运行上述代码后访问 http://127.0.0.1:5000，看到"Flask 安装成功！"即表示安装正确。
掌握 Flask 基础安装后，将学习如何实现常用的 HTTP 接口。涵盖 GET 和 POST 两种最常用的 HTTP 方法。
GET 请求用于从服务器获取数据，是最常用的 HTTP 方法。Flask 提供了简洁的路由装饰器语法来处理不同类型的 GET 请求。
以下举例，演示了最基本的路由定义，不接收任何参数，返回固定的 JSON 数据：
# main.py
from flask import Flask, jsonify, request
app = Flask(__name__)
@app.route('/api/hello', methods=['GET'])
def hello_world():
"""
最简单的 GET 接口示例：不接收任何参数，返回固定的欢迎消息。
常用于接口连通性测试。
"""
return jsonify({
'message': 'Hello, World!',
'method': 'GET',
'status': 'success'
})
if __name__ == '__main__':
app.run(debug=True, port=5000)
使用示例：
http://127.0.0.1:5000/api/hello
实际开发中，GET 请求常需要接收参数。Flask 支持两种主要的参数传递方式：路径参数和查询参数。
# main.py
from flask import Flask, jsonify, request
app = Flask(__name__)
@app.route('/api/user/<username>', methods=['GET'])
def get_user(username):
"""
1. 路径参数：username 来自 URL 路径本身
2. 查询参数：age 来自 URL 问号后的查询字符串
"""
age = request.args.get('age', default=18, type=int)
return jsonify({
'username': username,
'age': age,
'message': f'用户 {username} 的信息',
'method': 'GET',
'status': 'success'
})
if __name__ == '__main__':
app.run(debug=True, port=5000)
访问 http://127.0.0.1:5000/api/user/zhangsan?age=25
POST 请求用于向服务器提交数据，通常用于创建新资源。
以下举例展示如何处理 JSON 格式的 POST 请求。
# main.py
from flask import Flask, jsonify, request
app = Flask(__name__)
@app.route('/api/user', methods=['POST'])
def create_user():
"""
POST 请求特点：
1. 请求参数在请求体中，不在 URL 中显示
2. 通常用于创建、修改资源
3. 可以传输 JSON、表单、文件等多种格式数据
"""
data = request.get_json()
if not data:
return jsonify({'error': '没有提供数据'}), 400
username = data.get('username')
email = data.get('email')
if not username or not email:
return jsonify({'error': '用户名和邮箱是必填项'}), 400
user_data = {
'id': 1,
'username': username,
'email': email,
'created_at': '2024-01-01'
}
return jsonify({
'message': '用户创建成功',
'user': user_data,
'method': 'POST',
'status': 'success'
}), 201
if __name__ == '__main__':
app.run(debug=True, port=5000)
使用 Postman 测试：
POST http://127.0.0.1:5000/api/user
Headers: Content-Type: application/json
Body: {"username": "李四", "email": "[email protected]"}
除了 JSON 格式，表单提交是另一种常见的 POST 请求方式，常用于文本表单提交和文件上传。
# main.py
from flask import Flask, jsonify, request
app = Flask(__name__)
@app.route('/api/form/user', methods=['POST'])
def create_user_form():
content_type = request.headers.get('Content-Type', '').lower()
is_form_urlencoded = 'application/x-www-form-urlencoded' in content_type
is_form_data = 'multipart/form-data' in content_type
if not (is_form_urlencoded or is_form_data):
return jsonify({
'error': '不支持的 Content-Type',
'supported_types': ['application/x-www-form-urlencoded', 'multipart/form-data']
}), 415
username = request.form.get('username')
email = request.form.get('email')
if not username or username.strip() == '':
return jsonify({'error': '用户名是必填项'}), 400
if not email or email.strip() == '':
return jsonify({'error': '邮箱是必填项'}), 400
uploaded_files = {}
if is_form_data:
for filename, file in request.files.items():
if file and file.filename:
file.save(f'uploads/{file.filename}')
uploaded_files[filename] = {
'filename': file.filename,
'content_type': file.content_type,
'size': len(file.read())
}
file.seek(0)
user_data = {
'id': 1,
'username': username.strip(),
'email': email.strip(),
'created_at': '2024-01-01',
'format': 'form-data' if is_form_data else 'x-www-form-urlencoded',
'uploaded_files': uploaded_files
}
return jsonify({
'message': '用户创建成功',
'user': user_data,
'method': 'POST',
'status': 'success'
}), 201
if __name__ == '__main__':
app.run(debug=True, port=5000)
使用 Postman 测试：
POST http://127.0.0.1:5000/api/form/user
Headers: Content-Type: application/x-www-form-urlencoded
Body: username=lisi&email=lisi@example.com
现代 Web 应用开发中，数据库是不可或缺的核心组件。Flask 通过其出色的扩展机制，可以轻松集成多种数据库系统。数据库集成主要涉及两个方面：数据模型的建立和数据的持久化存储。
本示例使用 SQLite，因为它无需单独安装数据库服务器，且数据存储在单一文件中，便于开发和测试。
from flask import Flask, jsonify, request
from flask_sqlalchemy import SQLAlchemy
from datetime import datetime
flaskApp = Flask(__name__)
flaskApp.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///users.db'
flaskApp.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
sqliteDb = SQLAlchemy(flaskApp)
class User(sqliteDb.Model):
id = sqliteDb.Column(sqliteDb.Integer, primary_key=True)
username = sqliteDb.Column(sqliteDb.String(80), unique=True, nullable=False)
email = sqliteDb.Column(sqliteDb.String(120), unique=True, nullable=False)
created_at = sqliteDb.Column(sqliteDb.DateTime, default=datetime.utcnow)
def to_dict(self):
return {
'id': self.id,
'username': self.username,
'email': self.email,
'created_at': self.created_at.strftime('%Y-%m-%d %H:%M:%S')
}
with flaskApp.app_context():
sqliteDb.create_all()
Create, Read, Update, Delete 是任何数据驱动应用的基本操作。创建（Create）操作允许系统添加新数据记录。
@flaskApp.route('/api/create/user', methods=['POST'])
def create_user():
data = request.get_json()
required_fields = ['username', 'email']
for field in required_fields:
if field not in data or not data[field].strip():
return jsonify({'error': f'{field}是必填项'}), 400
if User.query.filter_by(username=data['username']).first():
return jsonify({'error': '用户名已存在'}), 409
if User.query.filter_by(email=data['email']).first():
return jsonify({'error': '邮箱已存在'}), 409
new_user = User(
username=data['username'],
email=data['email']
)
sqliteDb.session.add(new_user)
sqliteDb.session.commit()
return jsonify({
'message': '用户创建成功',
'user': new_user.to_dict()
}), 201
if __name__ == '__main__':
flaskApp.run(debug=True, port=5000)
使用 Postman 测试：
当用户数量较多时，直接返回所有用户可能导致性能问题。实际应用中应考虑分页。
@flaskApp.route('/api/users', methods=['GET'])
def get_all_users():
users = User.query.all()
return jsonify({
'users': [user.to_dict() for user in users],
'count': len(users)
})
if __name__ == '__main__':
flaskApp.run(debug=True, port=5000)
使用 Postman 测试：
RESTful API 通过 URL 路径参数定位具体资源。这种方式语义清晰，符合 REST 设计原则。
@flaskApp.route('/api/users/<int:user_id>', methods=['GET'])
def get_user(user_id):
user = User.query.get(user_id)
if user is None:
return jsonify({'error': '用户不存在'}), 404
return jsonify(user.to_dict())
if __name__ == '__main__':
flaskApp.run(debug=True, port=5000)
使用 Postman 测试：
搜索是用户界面的核心功能之一，支持模糊搜索。
@flaskApp.route('/api/users/search', methods=['GET'])
def search_users():
username = request.args.get('username', '')
email = request.args.get('email', '')
query = User.query
if username:
query = query.filter(User.username.contains(username))
if email:
query = query.filter(User.email.contains(email))
users = query.all()
return jsonify({
'users': [user.to_dict() for user in users],
'count': len(users),
'search_params': {'username': username, 'email': email}
})
if __name__ == '__main__':
flaskApp.run(debug=True, port=5000)
使用 Postman 测试：
以下示例实现的是 PUT 语义更新客户端提供的字段。
@flaskApp.route('/api/users/<int:user_id>', methods=['PUT'])
def update_user(user_id):
user = User.query.get(user_id)
if user is None:
return jsonify({'error': '用户不存在'}), 404
data = request.get_json()
if 'username' in data and data['username']:
existing_user = User.query.filter(
User.username == data['username'],
User.id != user_id
).first()
if existing_user:
return jsonify({'error': '用户名已被使用'}), 409
user.username = data['username']
if 'email' in data and data['email']:
existing_user = User.query.filter(
User.email == data['email'],
User.id != user_id
).first()
if existing_user:
return jsonify({'error': '邮箱已被使用'}), 409
user.email = data['email']
sqliteDb.session.commit()
return jsonify({
'message': '用户更新成功',
'user': user.to_dict()
})
if __name__ == '__main__':
flaskApp.run(debug=True, port=5000)
使用 Postman 测试：
删除操作需要谨慎处理。
@flaskApp.route('/api/users/<int:user_id>', methods=['DELETE'])
def delete_user(user_id):
user = User.query.get(user_id)
if user is None:
return jsonify({'error': '用户不存在'}), 404
sqliteDb.session.delete(user)
sqliteDb.session.commit()
return jsonify({'message': '用户删除成功'}), 200
if __name__ == '__main__':
flaskApp.run(debug=True, port=5000)
微信公众号「极客日志」，在微信中扫描左侧二维码关注。展示文案：极客日志 zeeklog
解析常见 curl 参数并生成 fetch、axios、PHP curl 或 Python requests 示例代码。 在线工具，curl 转代码在线工具，online
将字符串编码和解码为其 Base64 格式表示形式即可。 在线工具，Base64 字符串编码/解码在线工具，online
将字符串、文件或图像转换为其 Base64 表示形式。 在线工具，Base64 文件转换器在线工具，online
将 Markdown（GFM）转为 HTML 片段，浏览器内 marked 解析；与 HTML转Markdown 互为补充。 在线工具，Markdown转HTML在线工具，online
将 HTML 片段转为 GitHub Flavored Markdown，支持标题、列表、链接、代码块与表格等；浏览器内处理，可链接预填。 在线工具，HTML转Markdown在线工具，online
通过删除不必要的空白来缩小和压缩JSON。 在线工具，JSON 压缩在线工具，online