Struct OpenApiExample 

pub struct OpenApiExample {
    pub name: String,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub params: Option<Value>,
    pub result: Option<Value>,
}

OpenAPI example for a method

Fields

name: String

summary: Option<String>

description: Option<String>

params: Option<Value>

result: Option<Value>

Implementations

impl OpenApiExample

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

Create a new example

pub fn with_summary(self, summary: impl Into<String>) -> Self

Add summary

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

Add description

pub fn with_params(self, params: Value) -> Self

Add parameters

pub fn with_result(self, result: Value) -> Self

Add result

Trait Implementations

impl Clone for OpenApiExample

fn clone(&self) -> OpenApiExample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiExample

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenApiExample

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OpenApiExample

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

where __S: Serializer,

Serialize this value into the given Serde serializer.