Interface IRequestBody

Request body information of OpenAPI operation.

This interface defines the structure for request bodies in API routes. It corresponds to the requestBody section in OpenAPI specifications, providing both a description and schema reference for the request payload.

The content-type for all request bodies is always application/json. Even when file uploading is required, don't use multipart/form-data or application/x-www-form-urlencoded content types. Instead, just define an URI string property in the request body schema.

Note that, all body schemas must be transformable to a reference type defined in the components section as an object type.

In OpenAPI, this might represent:

{
  "requestBody": {
    "description": "Creation info of the order",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/IShoppingOrder.ICreate"
        }
      }
    }
  }
}
Copy