Struct OpenApiInfo 

pub struct OpenApiInfo {
    pub title: &'static str,
    pub version: &'static str,
    pub description: Option<&'static str>,
    pub terms_of_service: Option<&'static str>,
    pub contact_name: Option<&'static str>,
    pub contact_url: Option<&'static str>,
    pub contact_email: Option<&'static str>,
    pub license_name: Option<&'static str>,
    pub license_url: Option<&'static str>,
    pub servers: &'static [(&'static str, &'static str)],
    pub security_schemes: &'static [(&'static str, SecurityScheme)],
    pub tag_descriptions: &'static [(&'static str, &'static str)],
}

Top-level OpenAPI document configuration. Build at main.rs and pass to crate::App::launch_with_info.

Fields

title: &'static str

version: &'static str

description: Option<&'static str>

terms_of_service: Option<&'static str>

contact_name: Option<&'static str>

contact_url: Option<&'static str>

contact_email: Option<&'static str>

license_name: Option<&'static str>

license_url: Option<&'static str>

servers: &'static [(&'static str, &'static str)]

Each (url, description) pair becomes a server entry. The first is the default rendered by Swagger UI.

security_schemes: &'static [(&'static str, SecurityScheme)]

Security schemes available to routes. Routes attach to a scheme by name via security("name") on the route macro.

tag_descriptions: &'static [(&'static str, &'static str)]

Tag descriptions surfaced in the UI as section blurbs.

Trait Implementations

impl Clone for OpenApiInfo

fn clone(&self) -> OpenApiInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for OpenApiInfo

fn default() -> OpenApiInfo

Returns the “default value” for a type.