Python中如何创建REST API？-Python教程-PHP中文网

Python中如何创建REST API？

尼克

发布： 2025-05-04 20:15:01

原创

804人浏览过

在python中高效创建rest api的方法是使用flask或django框架，并遵循最佳实践。1.选择flask或django：flask适合轻量级和灵活的项目，django适用于复杂项目。2.使用flask-restful扩展简化开发。3.处理cors问题时使用flask-cors扩展。4.进行身份验证和授权时使用jwt。5.优化性能时使用异步处理、缓存和数据库优化，并保持代码可读性。

Python中如何创建REST API？

在Python中创建REST API确实是一件既有趣又有挑战的事情，尤其是当你开始深入了解各种框架和库的使用时。你可能已经知道，REST API是现代Web开发的核心之一，允许不同系统之间进行无缝的数据交换和通信。那么，如何在Python中高效地创建一个REST API呢？让我们一起探讨这个话题。

首先，我想分享一个我曾经遇到的问题：如何在不牺牲性能的情况下处理大量请求？这个问题其实引出了我们今天要讨论的核心——选择合适的框架和最佳实践。让我们从选择合适的框架开始吧。

在Python中，创建REST API最常见的选择是使用Flask或Django。Flask因其轻量级和灵活性而受到青睐，而Django则提供了一个全面的解决方案，适合更复杂的项目。个人而言，我更喜欢Flask，因为它允许我更自由地定制API的结构和行为。

立即学习“Python免费学习笔记（深入）”；

让我们来看一个简单的Flask REST API示例：

from flask import Flask, jsonify, request

app = Flask(__name__)

# 定义一个简单的API端点
@app.route('/api/greet', methods=['GET'])
def greet():
    name = request.args.get('name', 'World')
    return jsonify({'message': f'Hello, {name}!'}), 200

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

登录后复制

这个简单的示例展示了如何创建一个GET请求的端点，返回一个问候信息。使用jsonify可以轻松地将数据转换为JSON格式，request对象则允许我们访问查询参数。

不过，仅仅创建一个端点还远远不够。我们需要考虑如何处理POST、PUT、DELETE等请求，以及如何进行数据验证和错误处理。在这个过程中，我发现使用Flask-RESTful扩展可以大大简化我们的工作。它提供了一些额外的工具，例如请求解析和资源类，使得API的开发更加结构化和可维护。

下面是一个使用Flask-RESTful的更复杂的例子：

from flask import Flask
from flask_restful import Api, Resource, reqparse

app = Flask(__name__)
api = Api(app)

class User(Resource):
    def __init__(self):
        self.parser = reqparse.RequestParser()
        self.parser.add_argument('name', type=str, required=True, help='Name cannot be blank!')
        self.parser.add_argument('age', type=int, required=True, help='Age cannot be blank!')

    def post(self):
        args = self.parser.parse_args()
        return {'message': f'User {args["name"]} created with age {args["age"]}'}, 201

    def put(self):
        args = self.parser.parse_args()
        return {'message': f'User {args["name"]} updated with age {args["age"]}'}, 200

    def delete(self):
        return {'message': 'User deleted'}, 200

api.add_resource(User, '/api/user')

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

登录后复制

这个例子展示了如何创建一个处理POST、PUT和DELETE请求的资源类，使用reqparse进行数据验证。你会发现，使用这种方式可以更清晰地组织代码，并且更容易扩展。

当然，在创建REST API的过程中，我们还会遇到一些常见的问题和挑战。比如，如何处理跨域请求（CORS）？如何进行身份验证和授权？这些问题都需要我们在设计API时提前考虑。

关于CORS问题，我通常会使用Flask-CORS扩展来处理。以下是一个简单的示例：

from flask import Flask
from flask_cors import CORS

app = Flask(__name__)
CORS(app)

@app.route('/api/data')
def get_data():
    return {'data': 'Some data'}

登录后复制

对于身份验证和授权，我建议使用JWT（JSON Web Tokens）。它是一种轻量级的认证机制，可以很方便地在客户端和服务器之间传递用户信息。下面是一个简单的JWT身份验证示例：

from flask import Flask, jsonify, request
from flask_jwt_extended import JWTManager, jwt_required, create_access_token

app = Flask(__name__)
app.config['JWT_SECRET_KEY'] = 'your-secret-key'  # 请在生产环境中使用更安全的密钥
jwt = JWTManager(app)

@app.route('/login', methods=['POST'])
def login():
    username = request.json.get('username', None)
    password = request.json.get('password', None)
    if username != 'test' or password != 'test':
        return jsonify({"msg": "Bad username or password"}), 401

    access_token = create_access_token(identity=username)
    return jsonify(access_token=access_token), 200

@app.route('/protected', methods=['GET'])
@jwt_required()
def protected():
    return jsonify({'message': 'This is a protected route'})

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

登录后复制

在实际项目中，性能优化和最佳实践也是我们需要关注的重点。以下是一些建议：