ModelSerializers -> OpenAPI components/schemas/<Model> section?

[ad...@bit.io]

Hi All,

I use a number of ModelSerializers and would like my generated OpenAPI schema to have a components/schema/<Model> section that is referenced by the responseBody section of my methods. Is this possible? This will make my openapi-generater generated code much cleaner - instead of a lot of InlineType17 and so on I'd get 'MyUserModel'.

The feature in OA is: https://swagger.io/docs/specification/components/

I imagine with DRF we'd see each serializer turned into a section in components/schemas/<SerializerName>. Does this feature exist?

Thanks!

-Adam

[Matemática A3K]

Hey Adam,

That seems to be the default behavior in the current stable version, have you tried it?

https://www.django-rest-framework.org/api-guide/schemas/#get_components

 

Thanks!

-Adam

--
You received this message because you are subscribed to the Google Groups "Django REST framework" group.
To unsubscribe from this group and stop receiving emails from it, send an email to django-rest-fram...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-rest-framework/27567e07-974a-4ffe-b0e8-d8dc235f3bf5n%40googlegroups.com.

[Adam Fletcher]

Hmm, I’m just using 

https://www.django-rest-framework.org/api-guide/schemas/#generating-a-dynamic-schema-with-schemaview

Should I do more than that? 

Thanks!

To view this discussion on the web visit https://groups.google.com/d/msgid/django-rest-framework/CA%2BFDnhKWd00gxq1h8TuFK1AqZNkno9T0M9%3D1c7QUBYPK20yH8Q%40mail.gmail.com.

[Matemática A3K]

On Mon, Oct 12, 2020 at 12:25 AM Adam Fletcher <ad...@bit.io> wrote:

Hmm, I’m just using 

https://www.django-rest-framework.org/api-guide/schemas/#generating-a-dynamic-schema-with-schemaview

Should I do more than that? 

Should be the same, I'm using djangorestframework-3.12.1 and I see an output as your described desired output, so not sure why you are not seeing it (perhaps the problem is in your openapi-generater, I'm using "plain vanilla drf" (just get_schema_view), perhaps if you disable your openapi-generater and try the output from the current bundled generator, it may be easier to rebuild from there if you need more customizations)

 

To view this discussion on the web visit https://groups.google.com/d/msgid/django-rest-framework/CAEP43uOZmZrCE%2BZbrubMGEwDF--mDK%3DGB5uRJgL%3DJwEjEf2W9Q%40mail.gmail.com.

[Adam Fletcher]

Okay, this was because I was on 3.11.x - when I upgraded to 3.12.1, everything does what I expect - thanks!

-Adam

To view this discussion on the web visit https://groups.google.com/d/msgid/django-rest-framework/CA%2BFDnh%2BwZzH0z0YxacXbzXKtHoxRrvAYsUGY%3DgH7Z0FHqJ6Pbg%40mail.gmail.com.