提供するモデルアドミンクラス¶

JSONやYAMLで定義したシリアライザーは、実際にシリアライザークラスにしないと確認することができません。 YAMLで記述された定義からシリアライザーを作成するで説明した方法で確認することもできますが、入力や見栄えのテストを行うのには不十分です。そのため、definable-serializerでは django.contrib.admin.ModelAdmin を拡張した DefinableSerializerAdmin クラスを提供しています。

DefinableSerializerAdmin¶

class DefinableSerializerAdmin¶

DefinableSerializerAdminクラスでは以下の機能を提供します。

編集画面上部に定義されたシリアライザークラスの情報を表示する機能
restframeworkのもつBrowsable APIページを利用して定義されたシリアライザーを表示する機能

特にBrowsable APIページでは定義したシリアライザーの入力テストを行うことができるため、非常に有用です。組み込み方も非常に簡単で、通常は admin.ModelAdmin を利用するところを DefinableSerializerAdmin に入れ替えるだけです。

以下に使用例を示します。

from django.contrib import admin
from definable_serializer.admin import DefinableSerializerAdmin

from . import models as surveys_models


@admin.register(surveys_models.Survey)
class SurveyAdmin(DefinableSerializerAdmin):

    list_display = (
        "id",
        "title",
    )

    list_display_links = (
        "id",
        "title",
    )

正しく組み込まれるとadmin画面が以下のようになります。

画面上部にシリアライアーの定義が表示されます。