🌵

djangorestframework-camel-caseの導入方法

2025/01/09に公開

django

概要

djangorestframework-camel-caseはDRFでJSONレスポンスを返すとき、自動的にキーをキャメルケースに変換してくれるライブラリです。

例

たとえば、ユーザ情報を返却するAPIを叩いたとき

response.json

 {
 	username: "Yuji",
 	created_at: "2025-01-01",
 }

これが、こうなります。

response.json

 {
  	username: "Yuji",
  	createdAt: "2025-01-01",
 }

フロントエンドの言語では、キャメルケースで記述することが多いので統一性を出すことができます。

導入

ライブラリのインストール

pipenv環境ですと以下のコマンドでインストールできます。

pipenv install djangorestframework-camel-case

そして、settings.pyに以下のようにREST_FRAMEWORK(がなければ追加して)にコードを追加してセットアップ完了です。

settings.py

 REST_FRAMEWORK = {
     "DEFAULT_RENDERER_CLASSES": (
         "djangorestframework_camel_case.render.CamelCaseJSONRenderer",
         "djangorestframework_camel_case.render.CamelCaseBrowsableAPIRenderer",
     ),
     "DEFAULT_PARSER_CLASSES": (
         "djangorestframework_camel_case.parser.CamelCaseFormParser",
         "djangorestframework_camel_case.parser.CamelCaseMultiPartParser",
         "djangorestframework_camel_case.parser.CamelCaseJSONParser",
     ),
 }

概要

例

導入

ライブラリのインストール

Discussion