快捷導(dǎo)航

Python使用Flask創(chuàng)建 REST API的實現(xiàn)步驟

更新時間：2026年02月25日 08:26:24 作者：普通網(wǎng)友

本文主要介紹了Python使用Flask創(chuàng)建 REST API的實現(xiàn)步驟,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

REST API（Representational State Transfer Application Programming Interface）是一種基于 HTTP 協(xié)議的架構(gòu)風(fēng)格，廣泛用于構(gòu)建現(xiàn)代 Web 應(yīng)用程序的后端服務(wù)。Flask 是一個輕量級且靈活的 Python 微框架，非常適合快速開發(fā) RESTful API。本文將介紹如何使用 Flask 創(chuàng)建一個簡單的 REST API，并演示其基本功能。

環(huán)境準備

在開始之前，請確保您的系統(tǒng)已安裝以下工具和庫：

Python 3.x
pip
Flask

可以通過以下命令安裝 Flask：

pip install Flask

創(chuàng)建項目結(jié)構(gòu)

首先，我們創(chuàng)建一個基本的項目目錄結(jié)構(gòu)。假設(shè)項目名為 "flask-rest-api"：

flask-rest-api/
│
├── app.py
└── requirements.txt

其中，`app.py` 是主應(yīng)用程序文件，`requirements.txt` 用于記錄依賴項。

編寫代碼

打開 `app.py` 文件，輸入以下代碼：

from flask import Flask, jsonify, request
 
# 初始化 Flask 應(yīng)用
app = Flask(__name__)
 
# 模擬數(shù)據(jù)存儲
data_store = [
    {"id": 1, "name": "Alice"},
    {"id": 2, "name": "Bob"}
]
 
# 獲取所有用戶
@app.route('/users', methods=['GET'])
def get_users():
    return jsonify(data_store)
 
# 獲取單個用戶
@app.route('/users/', methods=['GET'])
def get_user(user_id):
    user = next((item for item in data_store if item["id"] == user_id), None)
    if user:
        return jsonify(user)
    else:
        return jsonify({"error": "User not found"}), 404
 
# 添加新用戶
@app.route('/users', methods=['POST'])
def add_user():
    new_user = request.get_json()
    data_store.append(new_user)
    return jsonify(new_user), 201
 
# 更新現(xiàn)有用戶
@app.route('/users/', methods=['PUT'])
def update_user(user_id):
    user = next((item for item in data_store if item["id"] == user_id), None)
    if user:
        updated_data = request.get_json()
        user.update(updated_data)
        return jsonify(user)
    else:
        return jsonify({"error": "User not found"}), 404
 
# 刪除用戶
@app.route('/users/', methods=['DELETE'])
def delete_user(user_id):
    global data_store
    data_store = [item for item in data_store if item["id"] != user_id]
    return jsonify({"message": "User deleted"}), 200
 
# 啟動應(yīng)用
if __name__ == '__main__':
    app.run(debug=True)

解釋代碼

上述代碼實現(xiàn)了一個簡單的 REST API，支持以下操作：

GET /users - 獲取所有用戶
GET /users/{id} - 獲取指定 ID 的用戶
POST /users - 添加新用戶
PUT /users/{id} - 更新現(xiàn)有用戶
DELETE /users/{id} - 刪除用戶

核心邏輯如下：

`data_store` 是一個模擬數(shù)據(jù)庫，用于存儲用戶數(shù)據(jù)。
每個路由都通過裝飾器 `@app.route` 定義，并指定 HTTP 方法（如 GET、POST 等）。
返回的數(shù)據(jù)使用 `jsonify` 轉(zhuǎn)換為 JSON 格式。

運行應(yīng)用

在項目根目錄下運行以下命令啟動 Flask 應(yīng)用：

python app.py

默認情況下，應(yīng)用將在本地主機的 5000 端口上運行。您可以使用瀏覽器或工具（如 Postman 或 curl）測試 API。

測試 API

以下是一些示例請求及其預(yù)期響應(yīng)：

請求	方法	URL	響應(yīng)
獲取所有用戶	GET	/users	[{"id": 1, "name": "Alice"}, {"id": 2, "name": "Bob"}]
獲取單個用戶	GET	/users/1	{"id": 1, "name": "Alice"}
添加新用戶	POST	/users	{'id': 3, 'name': 'Charlie'}
更新現(xiàn)有用戶	PUT	/users/1	{"id": 1, "name": "Alicia"}
刪除用戶	DELETE	/users/1	{"message": "User deleted"}

總結(jié)

通過本文的學(xué)習(xí)，您已經(jīng)掌握了如何使用 Flask 快速搭建一個 REST API。Flask 提供了高度的靈活性，使得開發(fā)者可以輕松擴展功能或集成其他模塊。希望本文能幫助您在實際項目中更好地利用 Flask 構(gòu)建高效、可維護的后端服務(wù)。

到此這篇關(guān)于Python使用Flask創(chuàng)建 REST API的實現(xiàn)步驟的文章就介紹到這了,更多相關(guān) Flask 創(chuàng)建 REST API內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: