flask jsonify vs json.dumps 違いを簡単に解説

さて、また管理部に全く関係ない内容ですが、ご勘弁ください。

今回はflaskのjsonifyとpython jsonモジュールのdumpsの違いを簡単に解説していきたいと思います。今回の記事もflaskを教えている時に聞かれた内容がベースになっています。

jsonモジュールがよく理解できていない方は以下の記事をご参照ください。

jsonの簡単な説明とpythonでjsonの取り扱い方法を説明していきます。jsonオブジェクトを取り扱う場合、jsonファイルを取り扱う場合の説明です。APIのレスポンスはjsonが主流ですし、credentialがjsonで与えられることが多いので、jsonモジュールに慣れていきます。

jsonifyを使うケース
jsonifyとjson.dumpsの違い
まとめ

jsonifyを使うケース

基本的にはwebAPIなどを実装する場合、レスポンスとしてjsonを返すことになりますが、jsonifyを使うとよしなにdict型のデータをjsonにしてくれます。

でも、dict型データをjsonにしてくれるだけであれば、jsonモジュールでdumpsを使用すれば同じことが可能ですよね？何が違うんでしょうか？

jsonifyとjson.dumpsの違い

それでは、本題のjsonifyとjson.dumpsの違いをみていきましょう。サンプルとして２つのエンドポイントを作成して、それぞれjsonifyとjson.dumpsでデータを返して違いをみていきます。

サンプルコード

それでは、今回利用するサンプルコードを以下に貼り付けます。

from flask import Flask
from flask import jsonify
import json

app = Flask(__name__)

@app.route("/api/getinfo", methods=["get"])
def getinfo():
    """
    getinfo api createby json.dumps
    :return: json
    """
    header_info = request.headers
    print(header_info)

    info = {"name":"test1",
            "age":25}
    return json.dumps(info)

@app.route("/api/getinfo2", methods=["get"])
def getinfo2():
    """
    getinfo2 api createby jsonify
    :return: json
    """

    info = {"name":"test1",
            "age":25}
    return jsonify(info)

if __name__ == '__main__':
    app.run(debug=True)