Drf-yasg: Data object for request_body

[andrenerd]

Is it possible to get rid of "data" node in case when request structure is defined using "request_body" attribute?

[axnsan12]

Hello,

I am sorry but I do not really understand your question. The data node is the request body. It is what is sent in the body part of a POST/PUt/PATCH request.

You can get rid of it by not using request_body...

[andrenerd]

it's ok, if it should be like that (please, close the issue in the case).

PS.
previously when i created swagger docs manually, all the body params are displayed without "data" node in the doc.

[andrenerd]

...and old rdf swagger doc generators do it the same "no data" way:

[axnsan12]

It seems to me that those are form parameters, not JSON body parameters. You will find that this library generates the same format for form requests (i.e. if your remove json renderers/parsers from the view).

However you will also find that form parameters do not support nesting, and the library your are referencing above would probably incorrectly represent any nested serializers in the request body as a plain string value.

[axnsan12]

You might find this an interesting read; http://drf-yasg.readthedocs.io/en/stable/custom_spec.html#swagger-spec-overview

Specifically the part about Schema vs Parameter.

[axnsan12]

Maybe an option to prefer form parameters could be useful for cases where there is no nesting?

[andrenerd]

@axnsan12
thanks.
it works well when DEFAULT_PARSER_CLASSES is set to FormParser/MultiPartParser.

[axnsan12]

Glad it worked out for you!

[hedleyroos]

@axnsan12 thread necromancy, but related to your earlier comment. I found a way to make form parameters support nesting. Is there a place to contribute this as a recipe?

[wajahatahmed245]

I want to request data in form data not in JSON how can I change that in yasg ? by default it is json form I want it to be in form data form @axnsan12

[bay007]

https://drf-yasg.readthedocs.io/en/stable/custom_spec.html#swagger-spec-overview

• request_body
  @swagger_auto_schema(methods=['put', 'post'], request_body=UserSerializer)