使用 Python 构建 RESTful API

使用 Python 构建 RESTful API

概述

本技术文档将指导你使用 Python 构建一个简单的 RESTful API。我们将使用 Flask 框架来实现 API，并使用 JSON 格式进行数据交换。

安装依赖

• Python 3.6 或更高版本： 可以从官方网站下载安装。
• Flask： 使用 pip 命令安装：

pip install Flask

创建项目结构

创建一个名为 api 的文件夹，并在其中创建一个名为 app.py 的文件。

api/
  ├── app.py

编写代码

在 app.py 文件中，编写以下代码：

from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/', methods=['GET'])
def index():
    return jsonify({'message': '欢迎使用我的 RESTful API!'})

@app.route('/users', methods=['GET'])
def get_users():
    users = [
        {'id': 1, 'name': '张三'},
        {'id': 2, 'name': '李四'},
    ]
    return jsonify(users)

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

运行 API

在终端中，进入 api 文件夹并执行以下命令：

python app.py

测试 API

• 访问首页： 在浏览器中打开 http://127.0.0.1:5000/，你应该看到一个包含 "欢迎使用我的 RESTful API!" 消息的 JSON 响应。

• 获取用户列表： 在浏览器中打开 http://127.0.0.1:5000/users，你应该看到一个包含两个用户对象的 JSON 响应。

扩展 API

你可以在此基础上扩展 API，添加更多功能，例如：

• 添加用户： 通过 POST 请求创建新用户。
• 更新用户： 通过 PUT 请求更新用户信息。
• 删除用户： 通过 DELETE 请求删除用户。
• 数据持久化： 将用户数据保存到数据库中。

总结

本技术文档展示了使用 Flask 框架构建 RESTful API 的基本步骤。你可以根据自己的需求，修改代码并添加更多功能。