Struct rocket_okapi::swagger_ui::SwaggerUIConfig

pub struct SwaggerUIConfig {
    pub url: String,
    pub urls: Vec<UrlObject>,
    pub deep_linking: bool,
    pub display_operation_id: bool,
    pub default_models_expand_depth: i32,
    pub default_model_expand_depth: i32,
    pub default_model_rendering: DefaultModelRendering,
    pub display_request_duration: bool,
    pub doc_expansion: DocExpansion,
    pub filter: Filter,
    pub max_displayed_tags: u32,
    pub show_extensions: bool,
    pub show_common_extensions: bool,
}

A struct containing information about where and how the openapi.json files are served.

Fields

url: String

The url to a single openapi.json file that is showed when the web ui is first opened.

urls: Vec<UrlObject>

A list of named urls that contain all the openapi.json files that you want to display in your web ui. If this field is populated, the url field is not used.

deep_linking: bool

If set to true, enables deep linking for tags and operations. See the Deep Linking documentation for more information. Default: false.

display_operation_id: bool

Controls the display of operationId in operations list. Default: false.

default_models_expand_depth: i32

The default expansion depth for models (set to -1 completely hide the models). Default: 1.

default_model_expand_depth: i32

The default expansion depth for the model on the model-example section. Default: 1.

default_model_rendering: DefaultModelRendering

Controls how the model is shown when the API is first rendered. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Example Value' links.) Default: DefaultModelRendering::Example.

display_request_duration: bool

Controls the display of the request duration (in milliseconds) for "Try it out" requests. Default: false.

doc_expansion: DocExpansion

Controls the default expansion setting for the operations and tags. Default: DocExpansion::List.

filter: Filter

If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Filtering is case sensitive matching the filter expression anywhere inside the tag. Default: Filter(false).

max_displayed_tags: u32

If set, limits the number of tagged operations displayed to at most this many. The default is to show all operations. Default: None (displays all tagged operations).

show_extensions: bool

Controls the display of vendor extension (x-) fields and values for Operations, Parameters, and Schema. Default: false.

show_common_extensions: bool

Controls the display of extensions (pattern, maxLength, minLength, maximum, minimum) fields and values for Parameters. Default: false.

Trait Implementations

impl Clone for SwaggerUIConfig

fn clone(&self) -> SwaggerUIConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SwaggerUIConfig

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

Formats the value using the given formatter.

impl Default for SwaggerUIConfig

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for SwaggerUIConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for SwaggerUIConfig

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

Serialize this value into the given Serde serializer.