1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
//! Implements [OpenAPI Request Body][request_body] types.
//!
//! [request_body]: https://spec.openapis.org/oas/latest.html#request-body-object
use std::collections::BTreeMap;
use serde::{Deserialize, Serialize};
use super::{builder, set_value, Content, Required};
builder! {
RequestBodyBuilder;
/// Implements [OpenAPI Request Body][request_body].
///
/// [request_body]: https://spec.openapis.org/oas/latest.html#request-body-object
#[non_exhaustive]
#[derive(Serialize, Deserialize, Default, Clone, PartialEq)]
#[cfg_attr(feature = "debug", derive(Debug))]
#[serde(rename_all = "camelCase")]
pub struct RequestBody {
/// Additional description of [`RequestBody`] supporting markdown syntax.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Map of request body contents mapped by content type e.g. `application/json`.
pub content: BTreeMap<String, Content>,
/// Determines whether request body is required in the request or not.
#[serde(skip_serializing_if = "Option::is_none")]
pub required: Option<Required>,
}
}
impl RequestBody {
/// Construct a new [`RequestBody`].
pub fn new() -> Self {
Default::default()
}
}
impl RequestBodyBuilder {
/// Add description for [`RequestBody`].
pub fn description<S: Into<String>>(mut self, description: Option<S>) -> Self {
set_value!(self description description.map(|description| description.into()))
}
/// Define [`RequestBody`] required.
pub fn required(mut self, required: Option<Required>) -> Self {
set_value!(self required required)
}
/// Add [`Content`] by content type e.g `application/json` to [`RequestBody`].
pub fn content<S: Into<String>>(mut self, content_type: S, content: Content) -> Self {
self.content.insert(content_type.into(), content);
self
}
}
/// Trait with convenience functions for documenting request bodies.
///
/// With a single method call we can add [`Content`] to our [`RequestBodyBuilder`] and
/// [`RequestBody`] that references a [schema][schema] using
/// content-type `"application/json"`.
///
/// _**Add json request body from schema ref.**_
/// ```rust
/// use utoipa::openapi::request_body::{RequestBodyBuilder, RequestBodyExt};
///
/// let request = RequestBodyBuilder::new().json_schema_ref("EmailPayload").build();
/// ```
///
/// If serialized to JSON, the above will result in a requestBody schema like this.
/// ```json
/// {
/// "content": {
/// "application/json": {
/// "schema": {
/// "$ref": "#/components/schemas/EmailPayload"
/// }
/// }
/// }
/// }
/// ```
///
/// [schema]: crate::ToSchema
///
#[cfg(feature = "openapi_extensions")]
#[cfg_attr(doc_cfg, doc(cfg(feature = "openapi_extensions")))]
pub trait RequestBodyExt {
/// Add [`Content`] to [`RequestBody`] referring to a _`schema`_
/// with Content-Type `application/json`.
fn json_schema_ref(self, ref_name: &str) -> Self;
}
#[cfg(feature = "openapi_extensions")]
impl RequestBodyExt for RequestBody {
fn json_schema_ref(mut self, ref_name: &str) -> RequestBody {
self.content.insert(
"application/json".to_string(),
crate::openapi::Content::new(crate::openapi::Ref::from_schema_name(ref_name)),
);
self
}
}
#[cfg(feature = "openapi_extensions")]
impl RequestBodyExt for RequestBodyBuilder {
fn json_schema_ref(self, ref_name: &str) -> RequestBodyBuilder {
self.content(
"application/json",
crate::openapi::Content::new(crate::openapi::Ref::from_schema_name(ref_name)),
)
}
}
#[cfg(test)]
mod tests {
use assert_json_diff::assert_json_eq;
use serde_json::json;
use super::{Content, RequestBody, RequestBodyBuilder, Required};
#[test]
fn request_body_new() {
let request_body = RequestBody::new();
assert!(request_body.content.is_empty());
assert_eq!(request_body.description, None);
assert!(request_body.required.is_none());
}
#[test]
fn request_body_builder() -> Result<(), serde_json::Error> {
let request_body = RequestBodyBuilder::new()
.description(Some("A sample requestBody"))
.required(Some(Required::True))
.content(
"application/json",
Content::new(crate::openapi::Ref::from_schema_name("EmailPayload")),
)
.build();
let serialized = serde_json::to_string_pretty(&request_body)?;
println!("serialized json:\n {serialized}");
assert_json_eq!(
request_body,
json!({
"description": "A sample requestBody",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailPayload"
}
}
},
"required": true
})
);
Ok(())
}
}
#[cfg(all(test, feature = "openapi_extensions"))]
#[cfg_attr(doc_cfg, doc(cfg(feature = "openapi_extensions")))]
mod openapi_extensions_tests {
use assert_json_diff::assert_json_eq;
use serde_json::json;
use crate::openapi::request_body::RequestBodyBuilder;
use super::RequestBodyExt;
#[test]
fn request_body_ext() {
let request_body = RequestBodyBuilder::new()
.build()
// build a RequestBody first to test the method
.json_schema_ref("EmailPayload");
assert_json_eq!(
request_body,
json!({
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailPayload"
}
}
}
})
);
}
#[test]
fn request_body_builder_ext() {
let request_body = RequestBodyBuilder::new()
.json_schema_ref("EmailPayload")
.build();
assert_json_eq!(
request_body,
json!({
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailPayload"
}
}
}
})
);
}
}