Coder Social home page Coder Social logo

Comments (2)

fletcheaston avatar fletcheaston commented on May 16, 2024

I've basically solved this myself without library additions, the solution isn't perfect but I'm pretty happy with it.

I'm using the pyhumps package for camel-casing my strings.

from ninja import Schema
from humps import camelize


def to_camel(string: str) -> str:
    return camelize(string)


class CamelCaseSchema(Schema):

    class Config:
        alias_generator = to_camel
        allow_population_by_field_name = True

    def dict(self, ignore_alias: bool = False, by_alias: bool = True, **kwargs) -> 'DictStrAny':
        if ignore_alias:
            return super().dict(by_alias=False, **kwargs)

        return super().dict(by_alias=True, **kwargs)

And then I just use CamelCaseSchema as a drop-in for Schema everywhere.

It's a little funky, and I'm ignoring the by_alias entirely (because Ninja seems to have its own mind about using aliases). The only time I don't want to use by_alias is when I'm directly serializing the object to a Django Model, then I have to use...

MyModel.objects.create(**myschema.dict(ignore_alias=True))

This method allows me to serialize directly to a Django Model and the schema shows up in the Swagger documentation correctly. I personally think adding this to the library would be beneficial. I'm happy to submit a PR and update the Ninja docs to highlight this use case @vitalik. If you reopen the issue, I can throw this and the docs together and submit a PR within a day or so.

from django-ninja.

bolinocroustibat avatar bolinocroustibat commented on May 16, 2024

Thanks @fletcheaston , very useful!

from django-ninja.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.