Flask JSON

Flask の JSON モジュールはシリアル化/デシリアル化機能を提供し、デフォルトでは Python 標準ライブラリの json を使用し、JSONProvider で置き換えることができます。

インポート方法:

from flask import jsonify

或

from flask.json import dumps, loads

jsonify 関数

最も一般的に使用される JSON レスポンス構築関数。Python オブジェクトを JSON Response にシリアル化します。

使用法 説明
jsonify(*args, **kwargs) パラメータを JSON にシリアル化し、Response を返します(Content-Type: application/json)
jsonify(dict) 辞書を JSON レスポンスにシリアル化
jsonify(key=value, ...) キーワード引数を JSON レスポンスにシリアル化

dumps / loads / dump / load

関数 シグネチャ 説明
dumps (obj, *, skipkeys=False, ensure_ascii=True, ...) Python オブジェクトを JSON 文字列にシリアル化
loads (s, *, ...) JSON 文字列を Python オブジェクトにデシリアル化
dump (obj, fp, *, ...) Python オブジェクトをシリアル化してファイルに書き込む
load (fp, *, ...) ファイルから読み取って JSON をデシリアル化

JSONProvider クラス

カスタマイズ可能な JSON ハンドラーの基底クラス。デフォルトの JSON 実装を置き換えるには、このクラスを継承して関連メソッドをオーバーライドします。

メソッド 説明
dumps(obj, **kwargs) オブジェクトを JSON 文字列にシリアル化
loads(s, **kwargs) JSON 文字列から Python オブジェクトにデシリアル化
response(obj) オブジェクトを JSON Response に変換します。jsonify や dict/list を返すときに使用します。

DefaultJSONProvider

デフォルトの JSONProvider 実装で、Python 標準ライブラリの json に基づきます。

属性/メソッド 説明
ensure_ascii 非 ASCII 文字をエスケープするかどうか。False に設定すると中国語の出力に対応します。
sort_keys key でソートして出力するかどうか。デフォルトは True
compact コンパクトな出力かどうか(空白なし)。デフォルトは False

JSON Tag シリアル化

flask.json.tagモジュールは datetime、tuple、set など、より多くの Python 型のシリアル化をサポートします。

タグ 対応する Python 型
JSONTaggedJSONSerializer 拡張版シリアライザーで、Session がデフォルトで使用します。タグ付きの JSON 形式をサポートしています。

コード例

例

from flask import Flask, jsonify

app = Flask(__name__)

@app.get("/api/me")
def me():
    # dict を返すと、Flask が自動的に jsonify を呼び出します
    return {
        "username": "サンプル",
        "email": "test@example.com",
        "roles": ["admin", "editor"]
    }

@app.get("/api/users")
def users():
    # list を返すと、Flask が自動的に jsonify を呼び出します
    return [
        {"id": 1, "name": "サンプル"},
        {"id": 2, "name": "admin"}
    ]

@app.get("/api/status")
def status():
    # 明示的に jsonify を使用
    return jsonify(status="ok", version="1.0")

# 中国語の JSON 出力を設定
app.json.ensure_ascii = False
# {"username": "サンプル", "description": "中文描述内容"}
その他の拡張