Struct ResponseDef 

pub struct ResponseDef {
    pub description: String,
    pub example: Option<Value>,
    pub content_type: Option<String>,
}

Response definition for OpenAPI documentation.

Fields

description: String

HTTP status code description.

example: Option<Value>

Optional example response body.

content_type: Option<String>

Content type for this response.

Implementations

impl ResponseDef

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

Create a new response definition with a description.

pub fn with_example(self, example: Value) -> Self

Set an example response body.

pub fn with_content_type(self, content_type: impl Into<String>) -> Self

Set the content type.

Trait Implementations

impl Clone for ResponseDef

fn clone(&self) -> ResponseDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseDef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.