Struct Operation 

pub struct Operation {
    pub tags: Option<Vec<String>>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub operation_id: Option<String>,
    pub parameters: Option<Vec<ParameterOrReference>>,
    pub request_body: Option<RequestBodyOrReference>,
    pub responses: BTreeMap<String, ResponseOrReference>,
    pub callbacks: Option<BTreeMap<String, Callback>>,
    pub deprecated: bool,
    pub security: Option<Vec<SecurityRequirement>>,
    pub servers: Option<Vec<Server>>,
    pub external_docs: Option<ExternalDocumentation>,
}

操作定义

Fields

tags: Option<Vec<String>>

操作标签

summary: Option<String>

操作摘要

description: Option<String>

操作描述

operation_id: Option<String>

操作 ID

parameters: Option<Vec<ParameterOrReference>>

参数列表

request_body: Option<RequestBodyOrReference>

请求体

responses: BTreeMap<String, ResponseOrReference>

响应定义

callbacks: Option<BTreeMap<String, Callback>>

回调定义

deprecated: bool

弃用标记

security: Option<Vec<SecurityRequirement>>

安全要求

servers: Option<Vec<Server>>

服务器列表

external_docs: Option<ExternalDocumentation>

外部文档

Implementations

impl Operation

pub fn new() -> Self

创建新操作

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

设置摘要

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

设置描述

pub fn operation_id(self, id: impl Into<String>) -> Self

设置操作 ID

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

添加标签

pub fn parameter(self, param: ParameterOrReference) -> Self

添加参数

pub fn request_body(self, body: RequestBodyOrReference) -> Self

设置请求体

pub fn response( self, status: impl Into<String>, resp: ResponseOrReference, ) -> Self

添加响应

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

设置弃用

Trait Implementations

impl Clone for Operation

fn clone(&self) -> Operation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Operation

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

Formats the value using the given formatter.

impl Default for Operation

fn default() -> Self

创建默认的操作

impl<'de> Deserialize<'de> for Operation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Operation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.