Falcon徹底解説：Python製 超高速APIフレームワークの魅力に迫る

リソースメソッドには、必ず `req` (リクエスト) と `resp` (レスポンス) の2つのオブジェクトが渡されます。これらを通じて、クライアントからの情報取得や、クライアントへの応答設定を行います。

• `req` オブジェクト:
  • req.params: クエリパラメータ (例: `/search?q=falcon`)
  • req.headers: リクエストヘッダー
  • req.method: HTTPメソッド (GET, POSTなど)
  • req.media: リクエストボディ (JSONやフォームデータなど、自動でパースされる)
  • req.stream: リクエストボディの生データストリーム
  • req.context: リクエスト間でデータを共有するための辞書
  • その他、アクセス元IPアドレス、URI情報など多数
• `resp` オブジェクト:
  • resp.status: HTTPステータスコード (例: `falcon.HTTP_200`)
  • resp.media: レスポンスボディ (JSON形式で返す場合などに利用)
  • resp.text: レスポンスボディ (テキスト形式)
  • resp.data: レスポンスボディ (バイト形式)
  • resp.set_header(name, value): レスポンスヘッダーの設定
  • resp.content_type: Content-Typeヘッダーの設定
  • その他、リダイレクト設定など

import falcon
import json
class ItemResource: def on_get(self, req, resp, item_id): # URIからパラメータを取得 print(f"Requested item ID: {item_id}") # クエリパラメータを取得 limit = req.get_param_as_int('limit') or 10 print(f"Query parameter limit: {limit}") # レスポンスを設定 resp.status = falcon.HTTP_200 resp.content_type = falcon.MEDIA_JSON resp.media = {"id": item_id, "name": f"Item {item_id}", "limit_used": limit} def on_post(self, req, resp): # リクエストボディ(JSON)を取得 try: item_data = req.get_media() print("Received item data:", item_data) # ... データ処理 ... resp.status = falcon.HTTP_201 # Created resp.media = {"message": "Item created", "data": item_data} except falcon.HTTPBadRequest as ex: # JSONパースエラーなどの場合 resp.status = ex.status resp.media = {"error": str(ex)}
app = falcon.App()
item_resource = ItemResource()
# URIテンプレートでパラメータを定義
app.add_route('/items/{item_id}', item_resource)
app.add_route('/items', item_resource) # POST用 (item_idなし)