DjangoのRest APIでJsonを返そうと思ったら思いの外ハマったポイントがあるのでまとめます。

何にハマった?

DjangoのAPIで商品モデル(Product)のデータを取得し、フロントのJavascriptで描画する、というものを作成していました。そこで、jsonデータ自体は返せるもの、商品モデルのnameに日本語を使った文字列が入っているので、文字化けが発生。

Jsonの文字化けを防ぐため、色々と調べるとjson.dumpsでJSON文字列を作るときにensure_asciiパラメータをFalseに設定すると良い、という情報がたくさん見つかりました。

これを参考に、以下のようなコードを組みましたが、今度はフロントエンド側でjson文字列がJSON.parce()で正常に配列化されない。 gist.github.com

ここでハマりました。

原因

一度Json.dumpsでJson文字列を作っているのに、JsonResponseでJson文字を再度Json化しようとしていたせいでした。

JsonResponseの実装を見ると

data=json.dumps(...)でjson化しています。ということは、JsonResponseを使うときはJson.dumpsしていない生のlistやdictを渡す必要があります。

公式DocにもdataはDictインスタンスを渡してね、って書いてありました。(・_・;) 悩んだら公式Docを読もう… docs.djangoproject.com

JsonResponseを使う場合、JsonResposneの引数json_dumps_paramsにdump時のパラメータを渡せるので、 {"ensure_ascii"=False}をパラメータと渡せば意図した結果になります。

というわけで、JSONデータを返すための実装方法はjson.dumpsを使ってHttpResponseで返すか、JsonResponseを使うか、になります。

こっちがスマート。 gist.github.com

Content-Typeをつけ忘れそうな気もする gist.github.com

最近、Djangoでとあるサービスを開発したのですがより使いやすく・自然な操作感のUXデザインを実現するべく、フロントエンドフレームワークのVue.jsを勉強しています。

フロントエンドフレームワークは初めて触るのでかなり手こずっていますが、勉強が一段落したら感想とか書いていきたいですね。