iT邦幫忙

2023 iThome 鐵人賽

DAY 28
0

處理請求和響應

  • 解析和驗證請求參數
    在 Flask RESTful 中,我們可以使用 reqparse 模組來解析和驗證請求的參數。這有助於確保 API 資源接收到正確的輸入。
from flask_restful import reqparse
# 創建一個請求解析器
parser = reqparse.RequestParser()
parser.add_argument('name', type=str, required=True, help='請提供名稱')
parser.add_argument('age', type=int, required=True, help='請提供年齡')

在上面的示例中,我們創建了一個請求解析器 parser,並定義了兩個參數 name 和 age,並指定它們的類型和必填性。當客戶端發送請求時,這個解析器將檢查並確保請求中包含了正確的參數,否則將返回錯誤響應。

  • 生成 JSON 響應
    當 API 資源需要返回數據給客戶端時,通常使用 JSON 來生成響應。我們可以使用 Flask 內建的 jsonify 函數來輕鬆生成 JSON 響應。
from flask import jsonify

data = {'name': 'John', 'age': 30}
return jsonify(data)

在這個示例中,我們創建了一個字典 data,然後使用 jsonify 函數將其轉換為 JSON 格式的響應。

錯誤處理

錯誤處理是開發 API 時的重要部分,它可以幫助客戶端了解發生的問題並提供有用的錯誤訊息。在 Flask RESTful 中,您可以使用 abort 函數來生成 HTTP 錯誤響應。

from flask_restful import abort

# 自定義錯誤代碼和錯誤訊息
abort(404, message='任務不存在')

在上面的示例中,我們使用 abort 函數生成了一個 HTTP 404 錯誤響應,並提供了自定義的錯誤代碼和錯誤訊息。這將使客戶端知道所請求的資源不存在。

我們還可以在 API 資源中使用 abort 函數來處理各種錯誤情況,例如參數驗證失敗、身份驗證問題等。

這是處理請求和響應以及錯誤處理的基本概念。在實際應用中,可以根據需求進一步定製這些功能。


上一篇
[Day 27]Flask RESTful API(1)
下一篇
[Day 29] 使用 Flask-RESTx 創建 RESTful API(3)
系列文
從開始到放棄的Flask30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言