Struct OpenApiInfo 

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

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

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.

title: Cow<'static, str>

version: Cow<'static, str>

description: Option<Cow<'static, str>>

terms_of_service: Option<Cow<'static, str>>

contact_name: Option<Cow<'static, str>>

contact_url: Option<Cow<'static, str>>

contact_email: Option<Cow<'static, str>>

license_name: Option<Cow<'static, str>>

license_url: Option<Cow<'static, str>>

servers: Vec<(Cow<'static, str>, Cow<'static, str>)>

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

security_schemes: Vec<(Cow<'static, str>, SecurityScheme)>

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

tag_descriptions: Vec<(Cow<'static, str>, Cow<'static, str>)>

Tag descriptions surfaced in the UI as section blurbs.

Implementations

impl OpenApiInfo

pub fn new( title: impl Into<Cow<'static, str>>, version: impl Into<Cow<'static, str>>, ) -> Self

Start from a title + version; chain the optional fields. Values may be &'static str or runtime Strings (config/env-driven services). (OpenApiInfo is #[non_exhaustive] — new spec fields can land without breaking downstream construction.)

pub fn description(self, v: impl Into<Cow<'static, str>>) -> Self

pub fn terms_of_service(self, v: impl Into<Cow<'static, str>>) -> Self

pub fn contact_name(self, v: impl Into<Cow<'static, str>>) -> Self

pub fn contact_url(self, v: impl Into<Cow<'static, str>>) -> Self

pub fn contact_email(self, v: impl Into<Cow<'static, str>>) -> Self

pub fn license( self, name: impl Into<Cow<'static, str>>, url: impl Into<Cow<'static, str>>, ) -> Self

pub fn server( self, url: impl Into<Cow<'static, str>>, description: impl Into<Cow<'static, str>>, ) -> Self

Add one server entry (url, human description — may be empty).

pub fn security_scheme( self, name: impl Into<Cow<'static, str>>, scheme: SecurityScheme, ) -> Self

Add one security scheme by name.

pub fn tag( self, name: impl Into<Cow<'static, str>>, description: impl Into<Cow<'static, str>>, ) -> Self

Add one tag description.

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.