Comments (2)
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.
Thanks @fletcheaston , very useful!
from django-ninja.
Related Issues (20)
- Overriding JSON schema title and summary without using `Field` HOT 1
- [BUG] CSRF Fails with Django Auth HOT 15
- [BUG] Order of operations affect response and request schemas HOT 1
- Documentation - link the schema article to the error article
- Add description to tags HOT 2
- Field order issue in JSON response HOT 1
- [BUG] Allow specifying field types for custom fields
- [BUG] The other API URLs work, but the openapi docs don't appear. HOT 5
- [BUG] Can't use parameter `keys`
- how to add a description for query params that shows in the generated docs?
- Field with list factory causes API docs to not load with non-serializable. HOT 2
- Annotate Decimal field does not supported "Unable to serialize unknown type: <class 'ellipsis'"
- Traversing the data structures to create an HTTP API client HOT 3
- how to use token ? HOT 1
- Path parameters, order matters HOT 3
- [BUG] Combining JWTAuth with django_auth only works in that order
- [BUG] Pydantic 2.7.0 incompatibily HOT 4
- [BUG] ModelSchema with ManyToManyField won't work under async views HOT 5
- How do you use aliases with nested objects
- [BUG] HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from django-ninja.