Struct salvo_oapi::Operation

#[non_exhaustive]
pub struct Operation {
    pub tags: Vec<String>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub operation_id: Option<String>,
    pub external_docs: Option<ExternalDocs>,
    pub parameters: Parameters,
    pub request_body: Option<RequestBody>,
    pub responses: Responses,
    pub callbacks: Option<String>,
    pub deprecated: Option<Deprecated>,
    pub securities: Vec<SecurityRequirement>,
    pub servers: Servers,
}

Implements OpenAPI Operation Object object.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

tags: Vec<String>

List of tags used for grouping operations.

When used with derive #[salvo_oapi::endpoint(...)] attribute macro the default value used will be resolved from handler path provided in #[openapi(paths(...))] with #[derive(OpenApi)] macro. If path resolves to None value crate will be used by default.

summary: Option<String>

Short summary what Operation does.

When used with derive #[salvo_oapi::endpoint(...)] attribute macro the value is taken from first line of doc comment.

description: Option<String>

Long explanation of Operation behaviour. Markdown syntax is supported.

When used with derive #[salvo_oapi::endpoint(...)] attribute macro the doc comment is used as value for description.

operation_id: Option<String>

Unique identifier for the API Operation. Most typically this is mapped to handler function name.

When used with derive #[salvo_oapi::endpoint(...)] attribute macro the handler function name will be used by default.

external_docs: Option<ExternalDocs>

Additional external documentation for this operation.

parameters: Parameters

List of applicable parameters for this Operation.

request_body: Option<RequestBody>

Optional request body for this Operation.

responses: Responses

List of possible responses returned by the Operation.

callbacks: Option<String>

Callback information.

deprecated: Option<Deprecated>

Define whether the operation is deprecated or not and thus should be avoided consuming.

securities: Vec<SecurityRequirement>

Declaration which security mechanisms can be used for for the operation. Only one SecurityRequirement must be met.

Security for the Operation can be set to optional by adding empty security with SecurityRequirement::default.

servers: Servers

Alternative Servers for this Operation.

Implementations

impl Operation

pub fn new() -> Self

Construct a new API Operation.

pub fn tags<I, T>(self, tags: I) -> Selfwhere I: IntoIterator<Item = T>, T: Into<String>,

Add or change tags of the Operation.

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

Append tag to Operation tags.

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

Add or change short summary of the Operation.

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

Add or change description of the Operation.

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

Add or change operation id of the Operation.

pub fn parameters<I: IntoIterator<Item = P>, P: Into<Parameter>>( self, parameters: I ) -> Self

Add or change parameters of the Operation.

pub fn add_parameter<P: Into<Parameter>>(self, parameter: P) -> Self

Append parameter to Operation parameters.

pub fn request_body(self, request_body: RequestBody) -> Self

Add or change request body of the Operation.

pub fn responses<R: Into<Responses>>(self, responses: R) -> Self

Add or change responses of the Operation.

pub fn add_response<S: Into<String>, R: Into<RefOr<Response>>>( self, code: S, response: R ) -> Self

Append status code and a Response to the Operation responses map.

• code must be valid HTTP status code.
• response is instances of Response.

pub fn deprecated<D: Into<Deprecated>>(self, deprecated: D) -> Self

Add or change deprecated status of the Operation.

pub fn securities<I: IntoIterator<Item = SecurityRequirement>>( self, securities: I ) -> Self

Add or change list of SecurityRequirements that are available for Operation.

pub fn add_security(self, security: SecurityRequirement) -> Self

Append SecurityRequirement to Operation security requirements.

pub fn servers<I: IntoIterator<Item = Server>>(self, servers: I) -> Self

Add or change list of Servers of the Operation.

pub fn add_server(self, server: Server) -> Self

Append a new Server to the Operation servers.

pub fn then<F>(self, func: F) -> Selfwhere F: FnOnce(Self) -> Self,

For easy chaining of operations.

Trait Implementations

impl Clone for Operation

fn clone(&self) -> Operation

Returns a copy 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() -> Operation

Returns the “default value” for a type.

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 PartialEq<Operation> for Operation

fn eq(&self, other: &Operation) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for Operation