在Linux下 使用 Flask 或 Django 开发 RESTful API

RESTful API是目前比较流行的一种API设计风格，它提供了一系列的面向资源的接口，便于客户端和服务器之间的通信。在本文中，我们将介绍如何使用Flask和Django这两个Python框架来开发RESTful API，并给出相应的学习代码。

一、Flask开发RESTful API

1. 安装Flask

在开始之前，我们需要先安装Flask。可以通过以下方式进行安装：

pip install --index-url https://pypi.tuna.tsinghua.edu.cn/simple flask

1. 创建Flask应用程序

（1）域内通信：

在使用Flask开发RESTful API之前，需要对其进行配置，并创建一个应用程序。我们可以通过如下方式创建一个基础应用：

from flask import Flask, jsonify, request
 
app = Flask(__name__)
 
@app.route('/')
def hello_world():
   return 'Hello World'
 
if __name__ == '__main__':
   app.run(host='127.0.0.1', port=8000)

这里我们创建了一个名为app的Flask实例。@app.route() 装饰器告诉 Flask 哪个 URL 可以触发我们的函数。 在本例中，当用户访问网站根目录时将调用hello_world()函数，然后返回"Hello World"。

（2）实现域间通信

        如果你的服务器只绑定到 localhost（即只监听 127.0.0.1），那么它将只能从同一台机器上访问。如果你想要从其他机器访问，你需要将服务器绑定到所有可用的网络接口，例如 0.0.0.0。

from flask import Flask, jsonify, request
 
app = Flask(__name__)
 
@app.route('/')
def hello_world():
   return 'Hello World'
 
if __name__ == '__main__':
   app.run(host='0.0.0.0', port=8000) 

 如在虚拟机192.168.48.138的浏览器中，你可以通过输入以下URL来访问服务器在虚拟机192.168.48.129上的资源：

http://192.168.48.129:8000

这里的 192.168.48.129 是服务器的IP地址，8000 是服务器监听的端口号。

注意，如果你的服务器在虚拟机上运行，并且你想要从主机访问它，你可能需要配置网络以允许主机访问虚拟机的网络。这通常涉及到虚拟机网络设置的配置，例如在 VirtualBox 中配置网络适配器的网络模式为 "桥接"。

2、创建基础RESTful API
现在我们需要创建一个简单的API来测试我们的项目是否正常工作。使用@app.route修饰器来定义HTTP请求的URL。

from flask import Flask, jsonify, request
app = Flask(__name__)
 
users = [
        {
            "id": 1,
            "name": "Alice",
            "age": 25
        },
        {
            "id": 2,
            "name": "Bob",
            "age": 30
        }
]
 
# Get all Users
@app.route('/users', methods=['GET'])
def get_users():
    return jsonify(users)
 
# Get Single User
@app.route('/users/<int:user_id>', methods=['GET'])
def get_user(user_id):
    user = [user for user in users if user['id'] == user_id]
    return jsonify(user[0])
 
if __name__ == '__main__':
   app.run()

Flask应用程序中定义了两个路由：

1. 获取所有用户的路由：通过发送GET请求到/users路径，可以获取所有用户的信息。

2. 获取单个用户的路由：通过发送GET请求到/users/<user_id>路径，可以获取特定用户的信息。<user_id>是一个占位符，用于指定要获取的用户的ID。

基于这些路由，你可以使用以下URL来访问这些功能：

• 获取所有用户：http://127.0.0.1:5000/users （假设你的应用程序监听在本地地址127.0.0.1的端口5000上）。
• 获取单个用户：http://127.0.0.1:5000/users/1 （假设要获取ID为1的用户）
• GET所有用户
• 
• GET单个用户
• 

请确保在运行Flask应用程序之前，已经安装了依赖项，并且应用程序正在监听正确的主机和端口。如果有必要，你可以根据需要进行更改

3、测试API：通过浏览器或API测试工具访问你的API服务，例如在浏览器中访问http://localhost:5000/，如果一切正常，你应该能够看到返回的JSON数据。

测试API的方法有很多种，以下是一些常用的方式：

• 使用浏览器访问API：可以在浏览器地址栏中输入API的URL，例如http://localhost:5000/，如果API正常运行，应该能够看到返回的JSON数据。

• 使用API测试工具：有很多API测试工具可供选择，例如Postman、Insomnia等。这些工具可以模拟各种HTTP请求，包括GET、POST、PUT、DELETE等，同时也可以设置请求头、请求参数、请求体等。使用这些工具可以更方便地测试API，并且可以保存测试结果以便后续分析。

• 编写测试脚本：可以使用Python、Java等编程语言编写测试脚本，通过调用API接口来进行测试。这种方式需要一定的编程技能和时间成本，但可以实现自动化测试，提高测试效率和准确性。

• 集成测试：在集成测试中，将API与其他组件（例如数据库、消息队列等）一起测试，以确保整个系统的功能正常。这种方式需要一定的系统架构和测试经验，同时也需要相应的测试环境和资源支持。

————————————————
原文链接：https://blog.csdn.net/qq_23926101/article/details/129960266