创建一个简单的 REST 接口可以通过 Python 中的 Flask 框架来实现。下面是创建一个简单 REST 接口的步骤:
第一步:安装 Flask
在终端中使用以下命令安装 Flask:
pip install flask
第二步:创建一个 Flask 应用
在 Python 中创建一个 .py 文件,添加以下内容以创建一个简单的 Flask 应用程序:
from flask import Flask, jsonify
app = Flask(__name__)
@app.route("/")
def hello():
return "Hello, World!"
if __name__ == "__main__":
app.run(debug=True)
这里我们创建了一个名为 app
的 Flask 应用程序,并创建了一个路由,当访问网站根目录时,在浏览器中将显示 “Hello, World!”。
第三步:为应用程序添加 API 端点
我们可以使用 Flask 中的 @app.route
装饰器来设置 API 端点。例如,我们创建一个 /api/users
的端点,可以添加以下代码到我们的应用程序中:
users = [
{"id": 1, "name": "John"},
{"id": 2, "name": "Jane"},
{"id": 3, "name": "Bob"}
]
@app.route("/api/users")
def get_users():
return jsonify(users)
这将返回 JSON 格式的用户数据。
示例 1:获取用户信息
import requests
response = requests.get("http://localhost:5000/api/users")
print(response.json())
示例 2:添加用户信息
import requests
user = {"id": 4, "name": "Tom"}
response = requests.post("http://localhost:5000/api/users", json=user)
print(response.json())
这里,我们使用 requests
模块发送 HTTP 请求,以获取或添加用户信息。
完整代码示例:
from flask import Flask, jsonify, request
app = Flask(__name__)
users = [
{"id": 1, "name": "John"},
{"id": 2, "name": "Jane"},
{"id": 3, "name": "Bob"}
]
@app.route("/")
def hello():
return "Hello, World!"
@app.route("/api/users", methods=["GET", "POST"])
def handle_users():
if request.method == "GET":
return jsonify(users)
elif request.method == "POST":
user = request.json
users.append(user)
return jsonify(user)
if __name__ == "__main__":
app.run(debug=True)
此处我们将 handle_users
函数更改为一个接受 GET
和 POST
请求的端点。对于 GET
请求,它返回用户信息,对于 POST
请求,它将新用户添加到用户列表并返回该用户信息。
使用上面提供的示例,您可以轻松创建您所需的 REST 接口。
本站文章如无特殊说明,均为本站原创,如若转载,请注明出处:Python 如何创建一个简单的REST接口 - Python技术站