如何使用 Flask 和 Python 创建 RESTful API

RESTful API 在现代开发中至关重要，它允许不同的系统以高效且可扩展的方式进行通信。 Python 及其 Flask 框架提供了一种简单而强大的方法来创建 API。在本指南中，我们将探索如何使用 Flask 创建 RESTful API，涵盖从基础知识到 HTTP 客户端的身份验证和使用的所有内容。

什么是 RESTful API？

在开始编写代码之前，了解什么是 RESTful API 非常重要。 API（应用程序编程接口）是一组允许一个软件与另一个软件通信的规则。 REST（表述性状态传输） 样式定义了 API 必须遵循的一组原则：

• 客户端-服务器：客户端（使用API​​）和服务器（提供数据）之间的分离。
• 无状态：客户端发出的每个请求都必须包含服务器处理所需的所有信息。
• 可缓存：可以缓存 API 响应以提高性能。
• 统一接口：客户端和服务器之间的通信必须以标准化的方式完成，使用 HTTP 方法，例如 GET、POST、PUT 和 DELETE。

使用 Flask 创建 RESTful API

现在我们将创建一个简单的 API 来管理用户列表。该 API 将允许您添加、编辑、查看和删除用户。

1.安装Flask

首先，确保你已经安装了 Flask。如果没有，您可以使用 pip 安装：

pip install Flask

2. 项目结构

我们的项目将具有以下结构：

/api_flask
│
├── app.py
└── requirements.txt

3. 配置 Flask

在 app.py 文件中，我们首先导入必要的库并配置我们的 Flask 应用程序：

from flask import Flask, jsonify, request

app = Flask(__name__)

# Dados simulados
users = [
    {'id': 1, 'name': 'Alice', 'email': 'alice@example.com'},
    {'id': 2, 'name': 'Bob', 'email': 'bob@example.com'}
]

4. 创建端点

现在，让我们为查看、添加、更新和删除用户创建端点。

4.1.列出用户的端点

我们将使用GET方法列出所有用户：

@app.route('/users', methods=['GET'])
def get_users():
    return jsonify(users), 200

4.2.获取特定用户的端点

我们将使用 GET 方法和用户 ID 来获取特定用户的详细信息：

@app.route('/users/<user_id>', methods=['GET'])
def get_user(user_id):
    user = next((user for user in users if user['id'] == user_id), None)
    if user:
        return jsonify(user), 200
    else:
        return jsonify({'message': 'User not found'}), 404
</user_id>

4.3.创建新用户的端点

POST 方法将用于添加新用户。客户端将以 JSON 格式发送数据。

@app.route('/users', methods=['POST'])
def create_user():
    data = request.get_json()
    new_user = {
        'id': len(users) + 1,
        'name': data['name'],
        'email': data['email']
    }
    users.append(new_user)
    return jsonify(new_user), 201

4.4.更新用户的端点

这里我们使用PUT方法来更新现有用户的数据：

@app.route('/users/<user_id>', methods=['PUT'])
def update_user(user_id):
    data = request.get_json()
    user = next((user for user in users if user['id'] == user_id), None)
    if user:
        user['name'] = data['name']
        user['email'] = data['email']
        return jsonify(user), 200
    else:
        return jsonify({'message': 'User not found'}), 404
</user_id>

4.5.删除用户的端点

我们使用DELETE方法来删除用户：

@app.route('/users/<user_id>', methods=['DELETE'])
def delete_user(user_id):
    global users
    users = [user for user in users if user['id'] != user_id]
    return jsonify({'message': 'User deleted'}), 200
</user_id>

5. 运行API

现在，只需运行我们的应用程序：

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

运行app.py文件，我们的API将在http://127.0.0.1:5000/users可用。

6. 使用 Flask 进行身份验证

要为我们的 API 添加一层安全性，我们可以使用 JWT（JSON Web 令牌）。使用 JWT，我们可以确保只有经过身份验证的用户才能访问某些端点。

6.1.安装 Flask-JWT-Extend

安装所需的扩展：

pip install Flask-JWT-Extended

6.2.配置 JWT

更新您的 app.py 文件以包含 JWT 身份验证：

from flask_jwt_extended import JWTManager, create_access_token, jwt_required

app.config['JWT_SECRET_KEY'] = 'your-secret-key'  # Troque pela sua chave secreta
jwt = JWTManager(app)

# Login para obter o token
@app.route('/login', methods=['POST'])
def login():
    data = request.get_json()
    if data['username'] == 'admin' and data['password'] == 'admin':
        access_token = create_access_token(identity={'username': 'admin'})
        return jsonify(access_token=access_token), 200
    else:
        return jsonify({'message': 'Invalid credentials'}), 401

# Exemplo de endpoint protegido
@app.route('/protected', methods=['GET'])
@jwt_required()
def protected():
    return jsonify({'message': 'Access granted to protected endpoint'}), 200

现在，当访问 /protected 端点时，需要在请求标头中发送 JWT 令牌来验证用户身份。

7. 通过 HTTP 客户端使用 API

要使用 API，我们可以使用 Postman 等工具或 Python 中的 requests 等库。

如何使用请求使用 API 的示例：

import requests

# Consumindo o endpoint de listagem de usuários
response = requests.get('http://127.0.0.1:5000/users')
print(response.json())

结论

使用 Flask 创建 RESTful API 既简单又灵活。 Flask 提供了一个简约的框架，可以扩展以包含身份验证、错误处理和其他安全层等功能。通过遵循 REST 原则和良好的开发实践，可以使用 Python 构建高效且可扩展的 API。

现在您可以使用 Flask 构建自己的 RESTful API，根据您的需求和要求进行自定义。

以上是如何使用 Flask 和 Python 创建 RESTful API的详细内容。更多信息请关注PHP中文网其他相关文章！