如何使用Flask建立RESTful API

在現今的軟體開發領域，RESTful API已經成為了許多應用程式的核心元件，其能夠提供可靠、可解耦、易於維護的服務。 Flask是一個輕量級的Python Web框架，它提供了一個靈活的方式來建立web應用程式以及RESTful API。在本文中，我們將介紹如何使用Flask來建立RESTful API。

1. 安裝Flask

首先，需要確保已經安裝Python和pip。在系統中開啟終端機或命令提示符，輸入下面的命令來安裝Flask：

pip install Flask

2. 建立專案資料夾

在本例中，我們建立一個名為「flask-restful」的專案資料夾。在終端機中輸入下面的命令來建立該資料夾：

mkdir flask-restful

3. 建立虛擬環境

建議使用虛擬環境以避免在系統上全域安裝Flask，這可以幫助我們在同一台電腦上開發多個專案。在終端機中輸入下方的指令來建立虛擬環境：

python3 -m venv env

4. 啟動虛擬環境

要在終端機中啟動虛擬環境，請輸入下列指令：

For Mac/Linux：

source env/bin/activate

For Windows：

envScriptsctivate

5. 新增必要的依賴項

##在Flask應用程式中，需要使用flask_restful庫和其它庫以安全地執行RESTful API請求。可以在虛擬環境中使​​用pip命令來安裝這些依賴項：

pip install flask_restful
pip install flask_cors

創建應用程式主檔案

在創建我們的RESTful API之前，我們需要建立一個應用程式主文件。在專案資料夾中建立一個名為「app.py」的文件，並新增以下程式碼：

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

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

users = [
    {
        "name": "Alice",
        "age": 22,
        "occupation": "Software Engineer"
    },
    {
        "name": "Bob",
        "age": 26,
        "occupation": "Data Analyst"
    },
    {
        "name": "Charlie",
        "age": 33,
        "occupation": "UI/UX Designer"
    }
]

class User(Resource):
    def get(self, name):
        for user in users:
            if(name == user["name"]):
                return user, 200
        return "User not found", 404

api.add_resource(User, "/user/<string:name>")

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

上面的程式碼建立了一個叫做「app」的Flask應用程式實例以及一個名為「api 」的flask_restful物件。它還定義了一些數據來儲存用戶資訊。在這個應用程式中，我們也定義了一個類別叫做“User”，該類別繼承自flask_restful的“Resource”類別。 User類別定義了兩個方法－get和post。我們僅實作了get方法，用於取得指定名字的使用者資料。最後，將User類別綁定到api上的/user/端點中。

執行應用程式

在終端機或命令提示字元中，輸入以下命令來啟動應用程式：

python app.py

然後，存取http:/ /localhost:5000/user/Alice（或其它使用者的名稱）即可取得該使用者資料。

新增CORS支援

CORS代表跨來源資源共享。使用RESTful API時，在開發環境下可以使用CORS支持，以避免跨域資源問題。在我們的應用程式中，我們使用flask_cors庫新增了CORS支援。要新增CORS支持，只需將以下程式碼新增至應用程式主檔案：

from flask_cors import CORS

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

此程式碼在應用程式實例和api定義之後新增。它將CORS中間件綁定到應用程式實例上。

結論

在本文中，我們介紹如何使用Flask建立RESTful API。我們從安裝Flask開始，然後建立專案資料夾、虛擬環境、新增依賴項以及建立應用程式主檔案。我們也學習如何新增CORS支援以協助解決跨網域資源請求問題。現在，您可以使用Flask輕鬆地建立RESTful API服務。

以上是如何使用Flask建立RESTful API的詳細內容。更多資訊請關注PHP中文網其他相關文章！