### 如何使用 Python Flask 或 Django 结合 MySQL 数据库并集成 Swagger #### 使用 Flask 集成 MySQL 和 Swagger Flask 是一个轻量级的 Web 框架，适合快速构建小型项目或微服务。以下是通过 Flask 实现系统接口并与 MySQL 数据库交互的最佳实践： 1. **安装依赖项** 安装必要的包以支持 Flask、MySQL 连接和 Swagger 文档生成功能。 ```bash pip install flask mysql-connector-python flasgger ``` 2. **配置 MySQL 数据库连接** 创建一个简单的数据库模型，并定义与 MySQL 的连接逻辑。 ```python import mysql.connector from mysql.connector import Error def create_db_connection(host_name, user_name, user_password, db_name): connection = None try: connection = mysql.connector.connect( host=host_name, user=user_name, passwd=user_password, database=db_name ) print("MySQL Database connection successful") except Error as err: print(f"Error: '{err}'") return connection ``` 3. **设置 Flask 路由和控制器** 编写路由函数处理 HTTP 请求并将数据保存到 MySQL 中。 ```python from flask import Flask, request, jsonify app = Flask(__name__) @app.route('/api/receipts', methods=['POST']) def add_receipt(): data = request.json conn = create_db_connection('localhost', 'root', '', 'receipts') # 替换为实际的数据库信息[^1] cursor = conn.cursor() insert_query = "INSERT INTO receipts (merchant_name, transaction_date, total_amount) VALUES (%s, %s, %s)" values = (data['merchant_name'], data['transaction_date'], data['total_amount']) cursor.execute(insert_query, values) conn.commit() return jsonify({"message": "Receipt added successfully"}), 201 ``` 4. **集成 Swagger UI** 使用 Flasgger 提供动态生成的 API 文档界面。 ```python from flasgger import Swagger template = { "swagger": "2.0", "info": { "title": "Flask Receipt Management API", "description": "API to manage receipt records using Flask and MySQL.", "version": "1.0" } } swagger = Swagger(app, template=template) @app.route('/api/docs') def docs(): """ Display the Swagger documentation. --- responses: 200: description: Returns a JSON object with details about available endpoints. """ return {"endpoints": ["/api/receipts"]} ``` --- #### 使用 Django 集成 MySQL 和 Swagger Django 是功能强大的全栈框架，适用于复杂的企业级应用。 1. **安装依赖项** 确保已安装所需的模块。 ```bash pip install django djangorestframework drf-yasg mysqlclient ``` 2. **配置 MySQL 数据库** 修改 `settings.py` 文件中的 DATABASES 设置部分。 ```python DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', 'NAME': 'your_database_name', 'USER': 'your_username', 'PASSWORD': 'your_password', 'HOST': 'localhost', 'PORT': '3306' } } ``` 3. **创建模型类** 定义用于存储收据信息的模型结构。 ```python from django.db import models class Receipt(models.Model): merchant_name = models.CharField(max_length=255) transaction_date = models.DateField() total_amount = models.DecimalField(max_digits=8, decimal_places=2) def __str__(self): return f"{self.merchant_name} - {self.transaction_date}" ``` 4. **编写视图和序列化器** 利用 REST Framework 处理请求响应。 ```python from rest_framework.views import APIView from rest_framework.response import Response from .models import Receipt from .serializers import ReceiptSerializer class AddReceiptAPIView(APIView): def post(self, request): serializer = ReceiptSerializer(data=request.data) if serializer.is_valid(): serializer.save() return Response(serializer.data, status=201) return Response(serializer.errors, status=400) ``` 5. **集成 Swagger 支持** 添加自动化的 API 文档生成功能。 ```python from drf_yasg.views import get_schema_view from drf_yasg import openapi from rest_framework.permissions import AllowAny schema_view = get_schema_view( openapi.Info( title="Django Receipt Management API", default_version='v1', description="A simple API built with Django Rest Framework." ), public=True, permission_classes=(AllowAny,) ) urlpatterns += [ path('swagger/', schema_view.with_ui('swagger', cache_timeout=0)), ] ``` --- #### 总结 无论是 Flask 还是 Django，在结合 MySQL 数据库的同时引入 Swagger 可以为开发者提供清晰直观的 API 接口文档。对于简单场景推荐使用 Flask，而对于更复杂的业务需求则建议采用 Django 来管理更大的代码规模和更高的扩展性[^2]。 ```python def example_function(): """This is an illustrative function.""" pass ```