Struct OpenApiConfig 

pub struct OpenApiConfig {
    pub exposed: bool,
    /* private fields */
}

OpenAPI runtime configuration.

Fields

exposed: bool

Returns true if the OpenAPI have been exposed.

This is a runtime flag set by App::use_open_api and is not configurable from a file.

Implementations

impl OpenApiConfig

pub fn new() -> Self

Creates a new OpenApiConfig with defaults.

pub fn with_title(self, title: impl Into<String>) -> Self

Sets the OpenAPI document title.

pub fn with_version(self, version: impl Into<String>) -> Self

Sets the OpenAPI document version.

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

Sets the OpenAPI document description.

pub fn with_spec(self, spec: OpenApiSpec) -> Self

Sets the OpenAPI spec.

Default: /openapi.json

pub fn with_specs<I, S>(self, specs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<OpenApiSpec>,

Sets the OpenAPI specs.

Default: /openapi.json

pub fn with_ui(self) -> Self

Enables or disables the OpenAPI UI.

Default: false

pub fn with_ui_path(self, path: impl Into<String>) -> Self

Sets the path where the OpenAPI UI is served.

Default: /openapi

pub fn title(&self) -> &str

Returns the title.

pub fn specs(&self) -> &[OpenApiSpec]

Returns a list of registered OpenAPI specs.

pub fn ui_enabled(&self) -> bool

Returns true if UI is enabled.

pub fn ui_path(&self) -> &str

Returns UI URL path.

Trait Implementations

impl Clone for OpenApiConfig

fn clone(&self) -> OpenApiConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiConfig

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

Formats the value using the given formatter.

impl Default for OpenApiConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpenApiConfig

where OpenApiConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.