目錄
一、概述​​
二、常用函數講解
1)Flask() 函數
2)route() 函數
3)jsonify() 函數
4)render_template() 函數
5)redirect() 函數
6)url_for() 函數
7)before_request() 函數
8)after_request() 函數
9)abort() 函數
10)send_file() 函數
三、常用物件解說
1)request 物件
2)session 物件
四、Flask 中的cookies 與session
首頁 後端開發 Python教學 如何使用Python Flask建立API函數?

如何使用Python Flask建立API函數?

Apr 21, 2023 pm 08:49 PM
python api flask

一、概述​​

Python Flask 是一個輕量級的 Web 框架,它提供了一個易於使用的 API 來建立 Web 應用程式。在 Flask 中,我們可以使用 Python 函數來定義 Web 應用程式的路由和處理程序。

二、常用函數講解

以下是一些常見的Python Flask API 函數:

1)Flask() 函數

這個函數是Flask 應用程式的核心,用來建立一個新的Flask 實例。

from flask import Flask
app = Flask(__name__)
登入後複製

2)route() 函數

這個函數用來指定路由和請求方法。可以使用多個 route() 函數來定義多個路由。

@app.route('/')
def hello_world():
    return 'Hello, World!'
登入後複製

3)jsonify() 函數

這個函數可以將 Python 物件轉換為 JSON 格式的回應物件。

from flask import jsonify
@app.route('/users')
def get_users():
    users = [
        {'name': 'Alice', 'age': 25},
        {'name': 'Bob', 'age': 30},
        {'name': 'Charlie', 'age': 35}
    ]
    return jsonify(users)
登入後複製

4)render_template() 函數

這個函數用來渲染模板並回傳 HTML 回應物件。可以使用模板引擎來動態產生 HTML。

from flask import render_template
@app.route(&#39;/profile/<username>&#39;)
def profile(username):
    return render_template(&#39;profile.html&#39;, name=username)
登入後複製

5)redirect() 函數

這個函數可以將請求重新導向到另一個 URL。

from flask import redirect
@app.route(&#39;/redirect&#39;)
def redirect_to_home():
    return redirect(&#39;/&#39;)
登入後複製

6)url_for() 函數

這個函數用來產生 URL,可以使用視圖函數的名稱作為參數。

from flask import url_for
@app.route(&#39;/profile/<username>&#39;)
def profile(username):
    return f&#39;Hello, {username}! Your profile URL is {url_for("profile", username=username)}.&#39;
登入後複製

7)before_request() 函數

這個函數用來註冊一個函數,在每個請求之前執行。

@app.before_request
def before_request():
    if &#39;user_id&#39; not in session and request.endpoint not in [&#39;login&#39;, &#39;static&#39;]:
        return redirect(url_for(&#39;login&#39;))
登入後複製

8)after_request() 函數

這個函數用來註冊一個函數,在每個請求之後執行。

@app.after_request
def after_request(response):
    response.headers[&#39;X-Frame-Options&#39;] = &#39;SAMEORIGIN&#39;
    return response
登入後複製

9)abort() 函數

這個函數用來在視圖函數中引發異常,並傳回一個錯誤回應。

from flask import abort
@app.route(&#39;/users/<int:user_id>&#39;)
def get_user(user_id):
    user = User.query.get(user_id)
    if user is None:
        abort(404)
    return jsonify(user.to_dict())
登入後複製

10)send_file() 函數

這個函數用來傳送檔案作為回應,可以將檔案當作位元組流或檔案路徑來傳送。

from flask import send_file
@app.route(&#39;/download&#39;)
def download_file():
    file_path = &#39;/path/to/file&#39;
    return send_file(file_path, as_attachment=True)
登入後複製

三、常用物件解說

1)request 物件

這個物件表示客戶端發出的請求,包含請求頭和請求體等資訊。可以使用 request 物件來取得客戶端發送的資料。

from flask import request
@app.route(&#39;/login&#39;, methods=[&#39;POST&#39;])
def login():
    username = request.form[&#39;username&#39;]
    password = request.form[&#39;password&#39;]
    return f&#39;Hello, {username}! Your password is {password}.&#39;
登入後複製

2)session 物件

這個物件可以用來儲存使用者會話數據,例如使用者 ID 等。

from flask import session
@app.route(&#39;/login&#39;, methods=[&#39;POST&#39;])
def login():
    username = request.form[&#39;username&#39;]
    password = request.form[&#39;password&#39;]
    if username == &#39;admin&#39; and password == &#39;password&#39;:
        session[&#39;user_id&#39;] = 1
        return redirect(&#39;/&#39;)
    else:
        return &#39;Invalid username or password.&#39;
登入後複製

四、Flask 中的cookies 與session

##1)cookies 與session 的介紹與區別

在Flask 中,Cookies 和Session 都是用來追蹤使用者狀態的機制。

Cookie 是一小段文字數據,當一個使用者造訪你的網站時,伺服器可以透過設定 cookie 把一些資料儲存在使用者的電腦上。當使用者再次造訪網站時,瀏覽器會傳送 cookie 資料給伺服器,以便伺服器可以使用該資料來識別使用者。 Flask 使用 Flask-Cookie 來處理 cookies,使用它可以設定、取得和刪除 cookies

Session 是一種在伺服器端儲存的狀態數據,與Cookie 不同,Session 資料不會儲存在使用者的電腦上,而是儲存在伺服器端。當一個使用者造訪你的網站時,伺服器會為該使用者建立一個唯一的Session ID,並將該ID 儲存在一個cookie 中,然後伺服器使用該Session ID 來識別使用者。 Flask 使用 Flask-Session 來處理 Session,使用它可以設定、取得和刪除 Session 資料。

一般來說,

Session 比較安全,因為資料儲存在伺服器端,而且使用者無法直接修改資料。 Cookie 的優點是可以儲存大量數據,並且可以在不同的頁面之間共用。在實際使用中,開發者可以根據需要選擇使用 CookieSession

以下是在Flask 中使用Cookies 和Session 的範例:

2)範例講解

1、使用Flask-Cookie 設定Cookie
from flask import Flask, make_response
app = Flask(__name__)
@app.route(&#39;/&#39;)
def index():
    response = make_response(&#39;Hello, World!&#39;)
    response.set_cookie(&#39;name&#39;, &#39;value&#39;)
    return response
if __name__ == &#39;__main__&#39;:
    app.run()
登入後複製
在在上面的範例中,我們使用Flask 的

make_response 函數建立一個回應對象,然後使用set_cookie 方法設定了一個名為name,值為valuecookie

2、使用Flask-Cookie 取得Cookie
from flask import Flask, request
app = Flask(__name__)
@app.route(&#39;/&#39;)
def index():
    name = request.cookies.get(&#39;name&#39;)
    return f&#39;Hello, {name}!&#39;
if __name__ == &#39;__main__&#39;:
    app.run()
登入後複製
在上面的範例中,我們使用Flask 的

request 物件取得了名為name#的cookie 的值,然後將其傳回給使用者。

3、使用Flask-Session 設定和取得Session
from flask import Flask, session
app = Flask(__name__)
app.config[&#39;SECRET_KEY&#39;] = &#39;your_secret_key&#39;
@app.route(&#39;/&#39;)
def index():
    session[&#39;name&#39;] = &#39;value&#39;
    name = session.get(&#39;name&#39;)
    return f&#39;Hello, {name}!&#39;
if __name__ == &#39;__main__&#39;:
    app.run()
登入後複製
在上面的範例中,我們使用Flask 的session 物件設定了一個名為name,值為value 的Session,並使用get 方法取得了該Session 的值,然後將其傳回給使用者。

要注意的是,為了使用

Flask-Session,需要在應用程式中設定一個 SECRET_KEY。此金鑰用於加密 Session 數據,以確保資料不會被竄改。

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

本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn

熱AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智慧驅動的應用程序,用於創建逼真的裸體照片

AI Clothes Remover

AI Clothes Remover

用於從照片中去除衣服的線上人工智慧工具。

Undress AI Tool

Undress AI Tool

免費脫衣圖片

Clothoff.io

Clothoff.io

AI脫衣器

Video Face Swap

Video Face Swap

使用我們完全免費的人工智慧換臉工具,輕鬆在任何影片中換臉!

熱工具

記事本++7.3.1

記事本++7.3.1

好用且免費的程式碼編輯器

SublimeText3漢化版

SublimeText3漢化版

中文版,非常好用

禪工作室 13.0.1

禪工作室 13.0.1

強大的PHP整合開發環境

Dreamweaver CS6

Dreamweaver CS6

視覺化網頁開發工具

SublimeText3 Mac版

SublimeText3 Mac版

神級程式碼編輯軟體(SublimeText3)

PHP和Python:解釋了不同的範例 PHP和Python:解釋了不同的範例 Apr 18, 2025 am 12:26 AM

PHP主要是過程式編程,但也支持面向對象編程(OOP);Python支持多種範式,包括OOP、函數式和過程式編程。 PHP適合web開發,Python適用於多種應用,如數據分析和機器學習。

在PHP和Python之間進行選擇:指南 在PHP和Python之間進行選擇:指南 Apr 18, 2025 am 12:24 AM

PHP適合網頁開發和快速原型開發,Python適用於數據科學和機器學習。 1.PHP用於動態網頁開發,語法簡單,適合快速開發。 2.Python語法簡潔,適用於多領域,庫生態系統強大。

Python vs. JavaScript:學習曲線和易用性 Python vs. JavaScript:學習曲線和易用性 Apr 16, 2025 am 12:12 AM

Python更適合初學者,學習曲線平緩,語法簡潔;JavaScript適合前端開發,學習曲線較陡,語法靈活。 1.Python語法直觀,適用於數據科學和後端開發。 2.JavaScript靈活,廣泛用於前端和服務器端編程。

PHP和Python:深入了解他們的歷史 PHP和Python:深入了解他們的歷史 Apr 18, 2025 am 12:25 AM

PHP起源於1994年,由RasmusLerdorf開發,最初用於跟踪網站訪問者,逐漸演變為服務器端腳本語言,廣泛應用於網頁開發。 Python由GuidovanRossum於1980年代末開發,1991年首次發布,強調代碼可讀性和簡潔性,適用於科學計算、數據分析等領域。

vs code 可以在 Windows 8 中運行嗎 vs code 可以在 Windows 8 中運行嗎 Apr 15, 2025 pm 07:24 PM

VS Code可以在Windows 8上運行,但體驗可能不佳。首先確保系統已更新到最新補丁,然後下載與系統架構匹配的VS Code安裝包,按照提示安裝。安裝後,注意某些擴展程序可能與Windows 8不兼容,需要尋找替代擴展或在虛擬機中使用更新的Windows系統。安裝必要的擴展,檢查是否正常工作。儘管VS Code在Windows 8上可行,但建議升級到更新的Windows系統以獲得更好的開發體驗和安全保障。

visual studio code 可以用於 python 嗎 visual studio code 可以用於 python 嗎 Apr 15, 2025 pm 08:18 PM

VS Code 可用於編寫 Python,並提供許多功能,使其成為開發 Python 應用程序的理想工具。它允許用戶:安裝 Python 擴展,以獲得代碼補全、語法高亮和調試等功能。使用調試器逐步跟踪代碼,查找和修復錯誤。集成 Git,進行版本控制。使用代碼格式化工具,保持代碼一致性。使用 Linting 工具,提前發現潛在問題。

notepad 怎麼運行python notepad 怎麼運行python Apr 16, 2025 pm 07:33 PM

在 Notepad 中運行 Python 代碼需要安裝 Python 可執行文件和 NppExec 插件。安裝 Python 並為其添加 PATH 後,在 NppExec 插件中配置命令為“python”、參數為“{CURRENT_DIRECTORY}{FILE_NAME}”,即可在 Notepad 中通過快捷鍵“F6”運行 Python 代碼。

vscode 擴展是否是惡意的 vscode 擴展是否是惡意的 Apr 15, 2025 pm 07:57 PM

VS Code 擴展存在惡意風險,例如隱藏惡意代碼、利用漏洞、偽裝成合法擴展。識別惡意擴展的方法包括:檢查發布者、閱讀評論、檢查代碼、謹慎安裝。安全措施還包括:安全意識、良好習慣、定期更新和殺毒軟件。

See all articles