設定HTTP狀態碼的正確方法

如何正確設定HTTP狀態碼，需具體程式碼範例

HTTP狀態碼是在進行網路通訊時，伺服器傳回給客戶端的一種狀態表示，它用來告知客戶端目前請求的處理情況。在設計和開發網頁應用程式時，正確設定HTTP狀態碼尤其重要，它可以幫助我們更好地處理請求和相應，並提供給使用者更好的使用者體驗。本文將介紹常見的HTTP狀態碼以及如何正確設定它們，同時提供程式碼範例。

1. 1xx 訊息類別（Informational）

1xx狀態碼表示伺服器已收到客戶端的請求，但仍在處理中。在大部分情況下，這些狀態碼對於開發者來說並不常用。

2. 2xx 成功類別（Success）

2xx狀態碼表示伺服器成功接收並處理了客戶端的請求。以下是常用的2xx狀態碼及其用途：

• 200 OK：請求成功。伺服器成功處理了請求，並傳回了相應的資訊。這通常是最常見的狀態碼之一。
• 201 Created：請求已成功並被建立。通常用於建立資源的請求，例如新增使用者或新建文章等。

範例程式碼：

@app.route('/users', methods=['POST'])
def create_user():
    # 创建用户逻辑
    # ...
    return jsonify({'message': 'User created'}), 201

• #204 No Content：請求成功但無內容。用於處理無需傳回具體資料的請求，例如刪除資源。

範例程式碼：

@app.route('/users/<int:user_id>', methods=['DELETE'])
def delete_user(user_id):
    # 删除用户逻辑
    # ...
    return '', 204

3. 3xx 重定向類別（Redirection）

3xx狀態碼表示需要客戶端進一步的操作才能完成請求。以下是常用的3xx狀態碼及其用途：

• 301 Moved Permanently：永久重定向。表示請求的資源已被移到新的URL，並且應該使用新URL存取。

範例程式碼：

@app.route('/old-url')
def old_url():
    return redirect('/new-url', code=301)

• 302 Found（或307 Temporary Redirect）：暫時重定向。表示請求的資源暫時被移到了新的URL，但客戶端仍應該保持原始請求的方法（GET/POST）。

範例程式碼：

@app.route('/old-url')
def old_url():
    return redirect('/new-url', code=302)

4. 4xx 用戶端錯誤類別（Client Error）

4xx狀態碼表示客戶端的請求有誤，伺服器無法處理。以下是常用的4xx狀態碼及其用途：

• 400 Bad Request：請求有誤。通常用於請求參數缺失、格式錯誤等情況。

範例程式碼：

@app.route('/users', methods=['POST'])
def create_user():
    username = request.form.get('username')
    if not username:
        return jsonify({'error': 'Username is required'}), 400
    # ...
    return jsonify({'message': 'User created'}), 201

• 401 Unauthorized：未授權。表示請求需要身份驗證，但用戶端未提供有效的身份憑證。

範例程式碼：

@app.route('/admin')
@auth_required
def admin_page():
    # ...

• 404 Not Found：資源不存在。表示請求的URL位址沒有對應的資源。

範例程式碼：

@app.route('/users/<int:user_id>')
def get_user(user_id):
    user = User.query.get(user_id)
    if not user:
        return jsonify({'error': 'User not found'}), 404
    return jsonify({
        'id': user.id,
        'username': user.username
    })

5. 5xx 伺服器錯誤類別（Server Error）

5xx狀態碼表示伺服器在處理請求時發生了錯誤。以下是常用的5xx狀態碼及其用途：

• 500 Internal Server Error：伺服器內部錯誤。表示伺服器在處理請求時發生了未知的錯誤。

範例程式碼：

@app.route('/users')
def get_users():
    try:
        users = User.query.all()
        return jsonify([user.to_dict() for user in users])
    except Exception as e:
        return jsonify({'error': 'Internal Server Error'}), 500

透過正確設定HTTP狀態碼，我們可以更好地處理請求和回應，並提供給使用者更好的使用者體驗。在實際開發中，根據具體的業務需求和API設計規範，選擇合適的HTTP狀態碼非常重要。同時，為了提高程式碼的可讀性和維護性，建議使用Web框架提供的狀態碼常數，而不是直接使用數字。

以上是設定HTTP狀態碼的正確方法的詳細內容。更多資訊請關注PHP中文網其他相關文章！