使用 Python 构建 RESTful API

使用 Python 构建 RESTful API

概述

本文档将介绍如何使用 Python 和 Flask 框架构建一个简单的 RESTful API。RESTful API 是一种基于 HTTP 协议的 Web API，使用标准的 HTTP 方法（如 GET、POST、PUT、DELETE）来访问和操作数据。

安装

首先，确保你已经安装了 Python 和 pip 包管理器。

bash python --version pip --version

然后，安装 Flask 框架：

bash pip install Flask

创建 API 项目

创建一个新的目录作为你的 API 项目，例如 myapi。

在 myapi 目录下创建一个名为 app.py 的文件，它将包含你的 API 代码。

定义 API 路由

在 app.py 文件中，使用 Flask 框架定义你的 API 路由：

```python from flask import Flask, jsonify

app = Flask(name)

@app.route('/users') def get_users(): """获取所有用户列表""" users = [ {'id': 1, 'name': 'John Doe'}, {'id': 2, 'name': 'Jane Doe'} ] return jsonify(users)

if name == 'main': app.run(debug=True) ```

这段代码定义了一个名为 /users 的路由，它使用 get_users() 函数来获取用户列表。

jsonify() 函数将 Python 列表转换为 JSON 格式的响应。

运行 API

在命令行中运行以下命令启动 API 服务器：

bash python app.py

现在，你可以在浏览器中访问 http://127.0.0.1:5000/users 来查看用户列表。

使用 HTTP 请求

除了浏览器，你还可以使用其他工具来发送 HTTP 请求，例如 curl 或 Postman。

例如，使用 curl 发送 GET 请求：

bash curl http://127.0.0.1:5000/users

你将在终端中看到 JSON 格式的用户列表。

其他 HTTP 方法

除了 GET 方法，RESTful API 还支持其他 HTTP 方法，例如：

• POST: 创建新的资源。
• PUT: 更新现有资源。
• DELETE: 删除资源。

你可以使用 Flask 框架中的 @app.route 装饰器来定义这些方法的路由。

总结

本文档介绍了使用 Python 和 Flask 框架构建 RESTful API 的基本步骤。

你可以根据自己的需求，扩展 API 功能，例如添加更多路由、数据库连接、用户认证等。