pub struct OperationBuilder { /* private fields */ }Expand description
操作构建器 — 描述单个 API 端点的元数据
Implementations§
Source§impl OperationBuilder
impl OperationBuilder
Sourcepub fn description(&mut self, desc: &str) -> &mut Self
pub fn description(&mut self, desc: &str) -> &mut Self
设置详细描述
Sourcepub fn parameter(
&mut self,
name: &str,
location: &str,
desc: &str,
required: bool,
schema_type: &str,
) -> &mut Self
pub fn parameter( &mut self, name: &str, location: &str, desc: &str, required: bool, schema_type: &str, ) -> &mut Self
添加参数
§参数
name:参数名location:参数位置(path/query/header/cookie)desc:参数描述required:是否必填schema_type:数据类型(string/integer/number/boolean/array)
Sourcepub fn response_with_schema(
&mut self,
status: u16,
desc: &str,
content_type: &str,
schema_ref: &str,
) -> &mut Self
pub fn response_with_schema( &mut self, status: u16, desc: &str, content_type: &str, schema_ref: &str, ) -> &mut Self
添加响应(带 schema 引用)
§参数
status:HTTP 状态码desc:响应描述content_type:内容类型schema_ref:schema 引用名(如"#/components/schemas/User")
Sourcepub fn deprecated(&mut self) -> &mut Self
pub fn deprecated(&mut self) -> &mut Self
标记为已弃用
Trait Implementations§
Auto Trait Implementations§
impl Freeze for OperationBuilder
impl RefUnwindSafe for OperationBuilder
impl Send for OperationBuilder
impl Sync for OperationBuilder
impl Unpin for OperationBuilder
impl UnsafeUnpin for OperationBuilder
impl UnwindSafe for OperationBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
Source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
Read this value from the supplied reader. Same as
ReadEndian::read_from_little_endian().Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.