Overriding Pydantic Config

There are many customizations available for a Django Ninja Schema, via the schema's Pydantic Config class.

Info

Under the hood Django Ninja uses Pydantic Models with all their power and benefits. The alias Schema was chosen to avoid confusion in code when using Django models, as Pydantic's model class is called Model by default, and conflicts with Django's Model class.

Example Camel Case mode

One interesting Config attribute is alias_generator. Using Pydantic's example in Django Ninja can look something like:

from ninja import Schema


def to_camel(string: str) -> str:
    return ''.join(word.capitalize() for word in string.split('_'))


class CamelModelSchema(Schema):
    str_field_name: str
    float_field_name: float

    class Config(Schema.Config):
        alias_generator = to_camel

Note

When overriding the schema's Config, it is necessary to inherit from the base Config class.

Keep in mind that when you want modify output for field names (like cammel case) - you need to set as well populate_by_name and by_alias

class UserSchema(ModelSchema):
    class Config:
        model = User
        model_fields = ["id", "email"]
        alias_generator = to_camel
        populate_by_name = True  # !!!!!! <--------


@api.get("/users", response=list[UserSchema], by_alias=True) # !!!!!! <-------- by_alias
def get_users(request):
    return User.objects.all()

results:

[
  {
    "Id": 1,
    "Email": "[email protected]"
  },
  {
    "Id": 2,
    "Email": "[email protected]"
  }
  ...
]

Custom Config from Django Model

When using create_schema, the resulting schema can be used to build another class with a custom config like:

from django.contrib.auth.models import User
from ninja.orm import create_schema


BaseUserSchema = create_schema(User)


class UserSchema(BaseUserSchema):

    class Config(BaseUserSchema.Config):
        ...