python 将数据库查询结果返回为接口

原创

mob649e8157ebce 2024-08-23 08:51:24 ©著作权

©著作权归作者所有：来自51CTO博客作者mob649e8157ebce的原创作品，请联系作者获取转载授权，否则将追究法律责任

用Python将数据库查询结果返回为接口

在现代Web开发中，API（应用程序接口）作为系统之间的交互枢纽，起着至关重要的作用。而在许多应用场景中，我们需要将数据库中的数据提取出来，并通过API的形式返回给前端或其他系统。本文将为大家详细阐述如何使用Python构建一个简单的API，将数据库查询结果返回给客户端，并提供示例代码和相关图形。

技术栈选择

我们将使用Flask作为Web框架，SQLite作为数据库。Flask是一个轻量级的Web框架，易于上手，非常适合构建小型的API。同时，SQLite是一个嵌入式数据库，适合快速开发和小型应用。

数据库模型

在我们的例子中，我们将创建一个存储用户信息的数据库。用户信息表将包含id、name和email字段。以下是ER图：

erDiagram
    USERS {
        INTEGER id PK "用户ID"
        STRING name "用户名"
        STRING email "电子邮件"
    }

实现步骤

接下来，我们将通过几个步骤实现这个功能。

创建数据库和表
插入一些示例数据
创建Flask API
从数据库查询数据并返回

1. 创建数据库和表

首先，我们需要创建一个SQLite数据库并定义用户信息表。

import sqlite3

# 创建数据库连接
conn = sqlite3.connect('users.db')

# 创建一个游标对象
cursor = conn.cursor()

# 创建用户表
cursor.execute('''
CREATE TABLE IF NOT EXISTS users (
    id INTEGER PRIMARY KEY AUTOINCREMENT,
    name TEXT NOT NULL,
    email TEXT NOT NULL UNIQUE
)
''')

# 提交并关闭连接
conn.commit()
conn.close()

2. 插入一些示例数据

我们将插入一些用户信息作为示例数据。

def insert_sample_data():
    conn = sqlite3.connect('users.db')
    cursor = conn.cursor()
    
    # 插入示例数据
    cursor.execute("INSERT INTO users (name, email) VALUES ('Alice', 'alice@example.com')")
    cursor.execute("INSERT INTO users (name, email) VALUES ('Bob', 'bob@example.com')")
    
    conn.commit()
    conn.close()
    
insert_sample_data()

3. 创建Flask API

现在，我们开始创建Flask API，从数据库中查询用户数据并返回JSON格式的响应。

from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/api/users', methods=['GET'])
def get_users():
    conn = sqlite3.connect('users.db')
    cursor = conn.cursor()
    
    cursor.execute("SELECT * FROM users")
    users = cursor.fetchall()
    
    # 转换为字典列表
    user_list = [{'id': user[0], 'name': user[1], 'email': user[2]} for user in users]
    
    conn.close()
    return jsonify(user_list)

if __name__ == '__main__':
    app.run(debug=True)

4. 测试API

启动Flask应用后，我们可以使用Postman或curl等工具进行测试。请求`

[
    {"id": 1, "name": "Alice", "email": "alice@example.com"},
    {"id": 2, "name": "Bob", "email": "bob@example.com"}
]

序列图

为了更好地理解客户端与服务器之间的交互，我们可以绘制一个序列图：

sequenceDiagram
    participant Client
    participant Server
    participant Database

    Client->>Server: GET /api/users
    Server->>Database: SELECT * FROM users
    Database-->>Server: 返回用户数据
    Server-->>Client: 返回用户数据 (JSON)