Struct Config

#[non_exhaustive]
pub struct Config {

    pub config_url: Option<String>,
    pub dom_id: Option<String>,
    pub url: Option<String>,
    pub urls_primary_name: Option<String>,
    pub urls: Vec<Url>,
    pub query_config_enabled: Option<bool>,
    pub deep_linking: Option<bool>,
    pub display_operation_id: Option<bool>,
    pub default_models_expand_depth: Option<isize>,
    pub default_model_expand_depth: Option<isize>,
    pub default_model_rendering: Option<String>,
    pub display_request_duration: Option<bool>,
    pub doc_expansion: Option<String>,
    pub filter: Option<bool>,
    pub max_displayed_tags: Option<usize>,
    pub show_extensions: Option<bool>,
    pub show_common_extensions: Option<bool>,
    pub try_it_out_enabled: Option<bool>,
    pub request_snippets_enabled: Option<bool>,
    pub oauth2_redirect_url: Option<String>,
    pub show_mutated_request: Option<bool>,
    pub supported_submit_methods: Option<Vec<String>>,
    pub validator_url: Option<String>,
    pub with_credentials: Option<bool>,
    pub persist_authorization: Option<bool>,
    pub layout: String,
}

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.

config_url: Option<String>

Url to fetch external configuration from.

dom_id: Option<String>

Id of the DOM element where Swagger UI will put it’s user interface.

url: Option<String>

Url the Swagger UI is serving.

urls_primary_name: Option<String>

Name of the primary url if any.

urls: Vec<Url>

Urls the Swagger UI is serving.

query_config_enabled: Option<bool>

Enables overriding configuration parameters with url query parameters.

deep_linking: Option<bool>

Controls whether deep linking is enabled in OpenAPI spec.

Deep linking automatically scrolls and expands UI to given url fragment.

display_operation_id: Option<bool>

Controls whether operation id is shown in the operation list.

default_models_expand_depth: Option<isize>

Default models expansion depth; -1 will completely hide the models.

default_model_expand_depth: Option<isize>

Default model expansion depth from model example section.

default_model_rendering: Option<String>

Defines how models is show when API is first rendered.

display_request_duration: Option<bool>

Define whether request duration in milliseconds is displayed for “Try it out” requests.

doc_expansion: Option<String>

Controls default expansion for operations and tags.

filter: Option<bool>

Defines is filtering of tagged operations allowed with edit box in top bar.

max_displayed_tags: Option<usize>

Controls how many tagged operations are shown. By default all operations are shown.

show_extensions: Option<bool>

Defines whether extensions are shown.

show_common_extensions: Option<bool>

Defines whether common extensions are shown.

try_it_out_enabled: Option<bool>

Defines whether “Try it out” section should be enabled by default.

request_snippets_enabled: Option<bool>

Defines whether request snippets section is enabled. If disabled legacy curl snipped will be used.

oauth2_redirect_url: Option<String>

Oauth redirect url.

show_mutated_request: Option<bool>

Defines whether request mutated with requestInterceptor will be used to produce curl command in the UI.

supported_submit_methods: Option<Vec<String>>

Define supported http request submit methods.

validator_url: Option<String>

Define validator url which is used to validate the Swagger spec. By default the validator swagger.io’s online validator is used. Setting this to none will disable spec validation.

with_credentials: Option<bool>

Enables passing credentials to CORS requests as defined fetch standards.

persist_authorization: Option<bool>

Defines whether authorizations is persisted throughout browser refresh and close.

layout: String

The layout of Swagger UI uses, default is "StandaloneLayout"

Implementations

impl Config

pub fn url<U: Into<Url>>(&mut self, u: U) -> &mut Self

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.