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 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
use proc_macro2::{Ident, TokenStream as TokenStream2};
use quote::{quote, ToTokens};
use syn::punctuated::Punctuated;
use syn::token::Comma;
use syn::{parenthesized, parse::Parse, token::Paren, Error, Token};
use crate::component::features::Inline;
use crate::component::ComponentSchema;
use crate::{parse_utils, AnyValue, Array, Required};
use super::example::Example;
use super::{PathType, PathTypeTree};
#[cfg_attr(feature = "debug", derive(Debug))]
pub enum RequestBody<'r> {
Parsed(RequestBodyAttr<'r>),
#[cfg(any(
feature = "actix_extras",
feature = "rocket_extras",
feature = "axum_extras"
))]
Ext(crate::ext::RequestBody<'r>),
}
impl ToTokens for RequestBody<'_> {
fn to_tokens(&self, tokens: &mut TokenStream2) {
match self {
Self::Parsed(parsed) => parsed.to_tokens(tokens),
#[cfg(any(
feature = "actix_extras",
feature = "rocket_extras",
feature = "axum_extras"
))]
Self::Ext(ext) => ext.to_tokens(tokens),
}
}
}
/// Parsed information related to request body of path.
///
/// Supported configuration options:
/// * **content** Request body content object type. Can also be array e.g. `content = [String]`.
/// * **content_type** Defines the actual content mime type of a request body such as `application/json`.
/// If not provided really rough guess logic is used. Basically all primitive types are treated as `text/plain`
/// and Object types are expected to be `application/json` by default.
/// * **description** Additional description for request body content type.
/// # Examples
///
/// Request body in path with all supported info. Where content type is treated as a String and expected
/// to be xml.
/// ```text
/// #[utoipa::path(
/// request_body = (content = String, description = "foobar", content_type = "text/xml"),
/// )]
///
/// It is also possible to provide the request body type simply by providing only the content object type.
/// ```text
/// #[utoipa::path(
/// request_body = Foo,
/// )]
/// ```
///
/// Or the request body content can also be an array as well by surrounding it with brackets `[..]`.
/// ```text
/// #[utoipa::path(
/// request_body = [Foo],
/// )]
/// ```
///
/// To define optional request body just wrap the type in `Option<type>`.
/// ```text
/// #[utoipa::path(
/// request_body = Option<[Foo]>,
/// )]
/// ```
#[derive(Default)]
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct RequestBodyAttr<'r> {
content: Option<PathType<'r>>,
content_type: Option<String>,
description: Option<String>,
example: Option<AnyValue>,
examples: Option<Punctuated<Example, Comma>>,
}
impl Parse for RequestBodyAttr<'_> {
fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {
const EXPECTED_ATTRIBUTE_MESSAGE: &str =
"unexpected attribute, expected any of: content, content_type, description, examples";
let lookahead = input.lookahead1();
if lookahead.peek(Paren) {
let group;
parenthesized!(group in input);
let mut request_body_attr = RequestBodyAttr::default();
while !group.is_empty() {
let ident = group
.parse::<Ident>()
.map_err(|error| Error::new(error.span(), EXPECTED_ATTRIBUTE_MESSAGE))?;
let attribute_name = &*ident.to_string();
match attribute_name {
"content" => {
request_body_attr.content = Some(
parse_utils::parse_next(&group, || group.parse()).map_err(|error| {
Error::new(
error.span(),
format!(
"unexpected token, expected type such as String, {error}",
),
)
})?,
);
}
"content_type" => {
request_body_attr.content_type =
Some(parse_utils::parse_next_literal_str(&group)?)
}
"description" => {
request_body_attr.description =
Some(parse_utils::parse_next_literal_str(&group)?)
}
"example" => {
request_body_attr.example = Some(parse_utils::parse_next(&group, || {
AnyValue::parse_json(&group)
})?)
}
"examples" => {
request_body_attr.examples =
Some(parse_utils::parse_punctuated_within_parenthesis(&group)?)
}
_ => return Err(Error::new(ident.span(), EXPECTED_ATTRIBUTE_MESSAGE)),
}
if !group.is_empty() {
group.parse::<Token![,]>()?;
}
}
Ok(request_body_attr)
} else if lookahead.peek(Token![=]) {
input.parse::<Token![=]>()?;
Ok(RequestBodyAttr {
content: Some(input.parse().map_err(|error| {
Error::new(
error.span(),
format!("unexpected token, expected type such as String, {error}"),
)
})?),
..Default::default()
})
} else {
Err(lookahead.error())
}
}
}
impl ToTokens for RequestBodyAttr<'_> {
fn to_tokens(&self, tokens: &mut TokenStream2) {
if let Some(body_type) = &self.content {
let media_type_schema = match body_type {
PathType::Ref(ref_type) => quote! {
utoipa::openapi::schema::Ref::new(#ref_type)
},
PathType::MediaType(body_type) => {
let type_tree = body_type.as_type_tree();
ComponentSchema::new(crate::component::ComponentSchemaProps {
type_tree: &type_tree,
features: Some(vec![Inline::from(body_type.is_inline).into()]),
description: None,
deprecated: None,
object_name: "",
})
.to_token_stream()
}
PathType::InlineSchema(schema, _) => schema.to_token_stream(),
};
let mut content = quote! {
utoipa::openapi::content::ContentBuilder::new()
.schema(#media_type_schema)
};
if let Some(ref example) = self.example {
content.extend(quote! {
.example(Some(#example))
})
}
if let Some(ref examples) = self.examples {
let examples = examples
.iter()
.map(|example| {
let name = &example.name;
quote!((#name, #example))
})
.collect::<Array<TokenStream2>>();
content.extend(quote!(
.examples_from_iter(#examples)
))
}
match body_type {
PathType::Ref(_) => {
tokens.extend(quote! {
utoipa::openapi::request_body::RequestBodyBuilder::new()
.content("application/json", #content.build())
});
}
PathType::MediaType(body_type) => {
let type_tree = body_type.as_type_tree();
let required: Required = (!type_tree.is_option()).into();
let content_type = self
.content_type
.as_deref()
.unwrap_or_else(|| type_tree.get_default_content_type());
tokens.extend(quote! {
utoipa::openapi::request_body::RequestBodyBuilder::new()
.content(#content_type, #content.build())
.required(Some(#required))
});
}
PathType::InlineSchema(_, _) => {
unreachable!("PathType::InlineSchema is not implemented for RequestBodyAttr");
}
}
}
if let Some(ref description) = self.description {
tokens.extend(quote! {
.description(Some(#description))
})
}
tokens.extend(quote! { .build() })
}
}