djangorestframework-camel-caseの導入方法

概要

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

GitHub - vbabiy/djangorestframework-camel-case: Camel case JSON support for Django REST framework.

Camel case JSON support for Django REST framework. - vbabiy/djangorestframework-camel-case

https://github.com/vbabiy/djangorestframework-camel-case

例

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

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

これが、こうなります。

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

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

導入

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

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

pipenv install djangorestframework-camel-case

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

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",
    ),
}