Struct Parameter 

pub struct Parameter {
    pub name: String,
    pub location: ParameterLocation,
    pub description: Option<String>,
    pub required: bool,
    pub schema: Option<Schema>,
    pub deprecated: bool,
    pub allow_empty_value: bool,
    pub example: Option<Value>,
    pub examples: Option<BTreeMap<String, ExampleOrReference>>,
}

参数定义

Fields

name: String

参数名称

location: ParameterLocation

参数位置

description: Option<String>

参数描述

required: bool

是否必需

schema: Option<Schema>

参数 Schema

deprecated: bool

是否废弃

allow_empty_value: bool

是否允许空值

example: Option<Value>

示例值

examples: Option<BTreeMap<String, ExampleOrReference>>

多个示例

Implementations

impl Parameter

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

创建路径参数

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

创建查询参数

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

创建请求头参数

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

创建 Cookie 参数

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

设置描述

pub fn required(self, required: bool) -> Self

设置必需

pub fn schema(self, schema: Schema) -> Self

设置 Schema

pub fn deprecated(self, deprecated: bool) -> Self

设置废弃

pub fn allow_empty_value(self, allow: bool) -> Self

设置允许空值

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

设置示例值

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Parameter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Parameter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.