JSON:API

[HrachMD]

This one also not issue, but a proposal.
It will be very useful for response schema validation in jsonapi standards.

[vitalik]

hi @HrachMD

Not sure I understand... do you have any references/links to this schema validation ?

[HrachMD]

Thank you for your response. I mean if we have such response schema:

class SigninOutput(Schema):

email: EmailStr
name: str

Then do not return just {'email': '', 'name': ''}
But instead do this kind transformation:
{'data': {'type': 'sometype', attributes: {'email': '', 'name': ''}}}

[hbutau]

Maybe we need something like this 👉 https://github.com/django-json-api/django-rest-framework-json-api

[skorokithakis]

We're having this issue as well, and currently the responses are a bit awkward because JSONAPI uses an "envelope" that the actual data gets wrapped in, so Ninja only ever sees the "envelope" and the resulting names are "wrong" (it basically thinks that every API returns a class of type Envelope).

Maybe it would be nice to have something that takes the proper classes and wraps them in the envelope.

[vitalik]

maybe what you need is custom renderer ?
https://django-ninja.rest-framework.com/tutorial/response-renderers/

Note: Django Ninja is designed on top of OpenAPI specifcation/standard

while JSON:API is an alternative standard

technically with custom renderer you can achieve responses like you describe, but autogenerated openapi docs and schema will be useless

[skorokithakis]

Ah, that makes sense, thank you.

[skorokithakis]

Does OpenAPI mandate the response schema that APIs should return? What is the recommended way of returning e.g. relationships in Ninja? Currently, if we need to return, for example, a User object and a Subscription object, we'll need to have a UserSubscriptionResponse class that contains them, and that can quickly become unwieldy with larger APIs.

[stephenrauch]

@skorokithakis You can use generics to help cleanup the code with embedded pydantic models. Here is an example for JSONAPI:

https://github.com/DeanWay/pydantic-jsonapi

[skorokithakis]

Hm, that's an interesting solution, thanks @stephenrauch. I don't think our juniors are going to love it, as generics are a rather advanced type concept, but it seems to solve the problem well, thanks.