Struct DocsConfig 

pub struct DocsConfig {
    pub enabled: bool,
    pub path: String,
    pub title: Option<String>,
}

Interactive API documentation (OpenAPI spec + Swagger UI).

Fields

enabled: bool

Serve the OpenAPI spec and Swagger UI (default true).

path: String

Path (under base_path) the Swagger UI is served at.

title: Option<String>

Title shown in the UI and the spec’s info.title. Unset falls back to the app’s name — see App::docs_title — so an app that renames itself renames its docs too.

Trait Implementations

impl Clone for DocsConfig

fn clone(&self) -> DocsConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocsConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DocsConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocsConfig

where DocsConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.