Struct utoipa::openapi::response::Response

#[non_exhaustive]
pub struct Response {
    pub description: String,
    pub headers: BTreeMap<String, Header>,
    pub content: IndexMap<String, Content>,
}

Implements OpenAPI Response Object.

Response is api operation response.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

description: String

Description of the response. Response support markdown syntax.

headers: BTreeMap<String, Header>

Map of headers identified by their name. Content-Type header will be ignored.

content: IndexMap<String, Content>

Map of response Content objects identified by response body content type e.g application/json.

Contents are stored within IndexMap to retain their insertion order. Swagger UI will create and show default example according to the first entry in content map.

Implementations

impl Response

pub fn new<S: Into<String>>(description: S) -> Self

Construct a new Response.

Function takes description as argument.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Response

fn default() -> Response

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Response

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<Response> for ResponseBuilder

fn from(value: Response) -> Self

Converts to this type from the input type.

impl From<ResponseBuilder> for Response

fn from(value: ResponseBuilder) -> Self

Converts to this type from the input type.

impl Serialize for Response

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.