RequestBody

This class represents the body of an HTTP request within an API specification. It defines the expected content types and their associated schemas, specifies whether the body is required for the request, and provides an optional description for documentation purposes.

Attributes

Attribute	Type	Description
description	`str	None` = null
content	dict[str, [MediaType](mediatype.md?sid=fastapi_openapi_models_mediatype)]	A mapping of media types to their respective schema definitions, defining the structure of the request payload.
required	`bool	None` = null

---

Constructor

Signature

def RequestBody(
    description: str | None = None,
    content: dict[str, [MediaType](mediatype.md?sid=fastapi_openapi_models_mediatype)],
    required: bool | None = None
) - > null

Parameters

Name	Type	Description
description	`str	None` = None
content	dict[str, [MediaType](mediatype.md?sid=fastapi_openapi_models_mediatype)]	The content of the request body. The key is a media type or media type range and the value describes it.
required	`bool	None` = None

---

Signature

def RequestBody(
    description: str | None = None,
    content: dict[str, [MediaType](mediatype.md?sid=fastapi_openapi_models_mediatype)] = null,
    required: bool | None = None
) - > null

Parameters

Name	Type	Description
description	`str	None` = None
content	dict[str, [MediaType](mediatype.md?sid=fastapi_openapi_models_mediatype)] = null	A mapping of content types to their respective media type definitions, defining the structure of the data expected in the request.
required	`bool	None` = None

---