使用 Flask 构建 JSON API 的小白指南
Flask 是一个非常流行的 Python Web 框架，可以帮助你轻松地构建 Web 应用程序和 API。今天，我们将一起学习如何使用 Flask 创建一个简单的 JSON API。
流程步骤
| 步骤 | 操作 |
|---|---|
| 1 | 安装 Flask |
| 2 | 创建 Flask 应用 |
| 3 | 定义数据模型 |
| 4 | 创建 API 路由 |
| 5 | 启动服务器 |
| 6 | 测试 API |
1. 安装 Flask
首先，请确保你已经安装了 Flask。打开你的终端或命令提示符，然后输入：
pip install Flask
这条命令会安装 Flask 及其依赖项。
2. 创建 Flask 应用
接下来，我们需要创建一个 Flask 应用。创建一个新的 Python 文件（例如 app.py），并添加以下代码：
from flask import Flask, jsonify
# 创建 Flask 应用实例
app = Flask(__name__)
from flask import Flask, jsonify：导入 Flask 类和 jsonify 函数。app = Flask(__name__)：创建 Flask 应用的实例。
3. 定义数据模型
假设我们要创建一个 API 来返回一些用户的信息。我们可以使用一个简单的字典来表示用户数据：
# 定义一个简单的用户数据
users = [
{"id": 1, "name": "Alice"},
{"id": 2, "name": "Bob"},
{"id": 3, "name": "Charlie"},
]
4. 创建 API 路由
现在，我们需要创建一个路由来返回 JSON 数据。在 app.py 文件中添加以下代码：
@app.route('/api/users', methods=['GET'])
def get_users():
return jsonify(users) # 返回用户数据的 JSON 响应
@app.route('/api/users', methods=['GET'])：定义一个新的路由，响应 GET 请求。return jsonify(users)：将用户数据转换为 JSON 格式并返回。
5. 启动服务器
在文件末尾添加以下代码，以启动 Flask 服务器：
if __name__ == "__main__":
app.run(debug=True) # 启动 Flask 服务器
app.run(debug=True)：启动 Flask 应用并启用调试模式。
6. 测试 API
在本地运行你的应用（在终端中输入 python app.py），然后打开浏览器访问 ` JSON 格式展示。
[
{"id": 1, "name": "Alice"},
{"id": 2, "name": "Bob"},
{"id": 3, "name": "Charlie"}
]
数据处理饼状图
使用 Mermaid 语法，我们可以展示数据处理的流程：
pie
title 数据处理
"获取用户数据": 30
"格式化为 JSON": 30
"返回响应": 40
状态图
接下来，我们还可以展示 API 调用的状态转移过程：
stateDiagram
[*] --> 初始化
初始化 --> 运行
运行 --> 处理请求
处理请求 --> 返回数据
返回数据 --> [*]
总结
今天，我们学习了如何使用 Flask 创建一个简单的 JSON API。通过六个步骤，你可以建立一个基本的 Web 服务返回用户信息。在实践中，你可以继续扩展这个 API，加上数据库支持、用户认证等功能，让它变得更加完善。希望这个指南能够帮助你更好地理解 Flask 的使用，祝你编程愉快！
