Describing a Request Body¶
Request bodies are typically used with “create” and “update” operations (POST, PUT, PATCH). For example, when creating a resource using POST or PUT, the request body usually contains the representation of the resource to be created. OpenAPI 3.0 provides the requestBody
keyword to describe request bodies.
To learn more about how request bodies are described by the OpenAPI Specification, checkout out the OpenAPI docs here.
When generating an operation
for an action method, Swashbuckle will automatically include a requestBody
if the action has a parameter or model property that is bound to the request body.
For example, given the following action method:
Swashbuckle will generate the following request body:
Note
In addition to the [FromBody]
attribute, Swashbuckle also supports parameters that are bound to form data via the [FromForm]
attribute and/or IFormFile
and IFormFileCollection
types. See Forms and File Uploads for more info.