Struct Operable 

pub struct Operable {
    pub type_name: &'static str,
    pub id: &'static str,
    pub group: Option<&'static str>,
    pub summary: Option<&'static str>,
    pub description: Option<&'static str>,
    pub deprecated: bool,
    pub security: Option<&'static str>,
    pub parameters: &'static Lazy<Vec<ParamConstructor>>,
    pub responses: &'static Lazy<Box<dyn Fn() -> Responses + Sync + Send + 'static>>,
}

Available on crate feature openapi only.

Everything the #[api] macro records about one handler, collected via inventory.

Fields

type_name: &'static str

Fully qualified name of the handler function, used to match a route to its Operable.

id: &'static str

The operation id.

group: Option<&'static str>

Tag the operation is grouped under.

summary: Option<&'static str>

Explicit summary; when absent it is derived from the id in Title Case.

description: Option<&'static str>

Description, taken from the handler’s doc comment.

deprecated: bool

Whether the operation is marked deprecated.

security: Option<&'static str>

Name of a security scheme this operation requires.

parameters: &'static Lazy<Vec<ParamConstructor>>

One constructor per handler argument.

responses: &'static Lazy<Box<dyn Fn() -> Responses + Sync + Send + 'static>>

Builds the operation’s responses from the handler’s return type.

Implementations

impl Operable

pub fn generate(&self, path: String) -> Operation

Build the OpenAPI operation for this handler at path.

Trait Implementations

impl Collect for Operable