Request Body for GET requests dont display in path /docs

[AndrejCoder]

First check

• I used the GitHub search to find a similar issue and didn't find it.
• I searched the FastAPI documentation, with the integrated search.
• I already searched in Google "How to X in FastAPI" and didn't find any information.

Description

Request Body for GET requests dont display in page path /docs. Is it bug or feature?

[nsidnev]

Have you looked here?

[AndrejCoder]

Yes, I understand that this has not yet been released, because the lines have not been changed ?

METHODS_WITH_BODY = set(("POST", "PUT", "DELETE", "PATCH"))

[nsidnev]

Yes, it seems so. Adding "GET" to this set will show the request body in the swagger docs. But I think this is still not very useful for Swagger (and ReDoc, which just won't show this route).

As I understand it, a Swagger can't send a request on this route. More information can be found here and in Swagger-UI repo.

[tiangolo]

Yep, what @nsidnev said ☝️

If possible, to avoid headaches with interoperability with other tools, you should use POST instead if you want to receive a body.

[chris-allnutt]

Open API v3.0 spec does not support request body for GET requests
Relevant documentation here https://swagger.io/docs/specification/describing-request-body/

GET, DELETE and HEAD are no longer allowed to have request body because it does not have defined semantics as per RFC 7231

You can still override this if you really want it, but I'm not sure if the doc generation will process it https://fastapi.tiangolo.com/advanced/extending-openapi/

[github-actions[bot]]

Assuming the original need was handled, this will be automatically closed now. But feel free to add more comments or create new issues or PRs.

[DoubtMail]

even for post requests the text field for body doesnt appear if we use @app.post(request: Request)