使用 Python 构建简单 REST API

使用 Python 构建简单 REST API

作者: 随机生成技术文档

日期: 2023-10-26

版本: 1.0

概述

本文档介绍如何使用 Python 和 Flask 框架构建一个简单的 REST API。

先决条件

• Python 3.6 或更高版本
• Flask 框架

安装

使用 pip 安装 Flask：

bash pip install Flask

代码示例

以下代码示例展示了一个简单的 REST API，它提供一个端点 /users 来获取所有用户列表：

```python from flask import Flask, jsonify

app = Flask(name)

@app.route('/users', methods=['GET']) def get_users(): users = [ {'id': 1, 'name': 'John Doe'}, {'id': 2, 'name': 'Jane Doe'} ] return jsonify(users)

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

运行 API

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

bash python app.py

API 服务器将在默认端口 5000 上运行。

测试 API

使用工具如 Postman 或 curl 来发送 GET 请求到 /users 端点：

bash curl http://localhost:5000/users

这将返回一个 JSON 格式的响应，包含所有用户的列表。

扩展

• 添加更多端点以支持其他操作，例如创建、更新和删除用户。
• 使用数据库来存储用户信息。
• 实现身份验证和授权机制。

总结

本文档介绍了使用 Python 和 Flask 框架构建一个简单的 REST API 的基本步骤。您可以根据需要扩展此 API 以满足您的特定需求。