Struct utoipa::openapi::response::ResponseBuilder

pub struct ResponseBuilder { /* private fields */ }

Builder for Response with chainable configuration methods to create a new Response.

Implementations

impl ResponseBuilder

pub fn new() -> ResponseBuilder

Constructs a new ResponseBuilder.

pub fn build(self) -> Response

Constructs a new Response taking all fields values from this object.

impl ResponseBuilder

pub fn description<I: Into<String>>(self, description: I) -> Self

Add description. Description supports markdown syntax.

pub fn content<S: Into<String>>(self, content_type: S, content: Content) -> Self

Add Content of the Response with content type e.g application/json.

pub fn header<S: Into<String>>(self, name: S, header: Header) -> Self

Add response Header.

pub fn extensions(self, extensions: Option<HashMap<String, Value>>) -> Self

Add openapi extensions (x-something) to the Header.

Trait Implementations

impl Default for ResponseBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<Response> for ResponseBuilder

fn from(value: Response) -> Self

Converts to this type from the input type.

impl From<ResponseBuilder> for RefOr<Response>

fn from(builder: ResponseBuilder) -> 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 ResponseExt for ResponseBuilder

fn json_schema_ref(self, ref_name: &str) -> ResponseBuilder

Available on crate feature openapi_extensions only.

Add Content to Response referring to a schema with Content-Type application/json.