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

一、概述​​

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('/redirect')
def redirect_to_home():
    return redirect('/')

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 'user_id' not in session and request.endpoint not in ['login', 'static']:
        return redirect(url_for('login'))

8）after_request() 函數

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

@app.after_request
def after_request(response):
    response.headers['X-Frame-Options'] = 'SAMEORIGIN'
    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('/download')
def download_file():
    file_path = '/path/to/file'
    return send_file(file_path, as_attachment=True)

三、常用物件解說

1）request 物件

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

from flask import request
@app.route('/login', methods=['POST'])
def login():
    username = request.form['username']
    password = request.form['password']
    return f'Hello, {username}! Your password is {password}.'

2）session 物件

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

from flask import session
@app.route('/login', methods=['POST'])
def login():
    username = request.form['username']
    password = request.form['password']
    if username == 'admin' and password == 'password':
        session['user_id'] = 1
        return redirect('/')
    else:
        return 'Invalid username or password.'

四、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 的優點是可以儲存大量數據，並且可以在不同的頁面之間共用。在實際使用中，開發者可以根據需要選擇使用 Cookie 或 Session。

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

2）範例講解

1、使用Flask-Cookie 設定Cookie

from flask import Flask, make_response
app = Flask(__name__)
@app.route('/')
def index():
    response = make_response('Hello, World!')
    response.set_cookie('name', 'value')
    return response
if __name__ == '__main__':
    app.run()

在在上面的範例中，我們使用Flask 的

make_response 函數建立一個回應對象，然後使用set_cookie 方法設定了一個名為name，值為value 的cookie。

2、使用Flask-Cookie 取得Cookie

from flask import Flask, request
app = Flask(__name__)
@app.route('/')
def index():
    name = request.cookies.get('name')
    return f'Hello, {name}!'
if __name__ == '__main__':
    app.run()

在上面的範例中，我們使用Flask 的

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

3、使用Flask-Session 設定和取得Session

from flask import Flask, session
app = Flask(__name__)
app.config['SECRET_KEY'] = 'your_secret_key'
@app.route('/')
def index():
    session['name'] = 'value'
    name = session.get('name')
    return f'Hello, {name}!'
if __name__ == '__main__':
    app.run()

在上面的範例中，我們使用Flask 的session 物件設定了一個名為name，值為value 的Session，並使用get 方法取得了該Session 的值，然後將其傳回給使用者。

要注意的是，為了使用

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

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