Struct swagger_ui::Config [−][src]
Swagger UI configuration
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)
.
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 Config
[src]
impl Debug for Config
[src]
impl Default for Config
[src]
impl<'de> Deserialize<'de> for Config
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Serialize for Config
[src]
Auto Trait Implementations
impl RefUnwindSafe for Config
impl Send for Config
impl Sync for Config
impl Unpin for Config
impl UnwindSafe for Config
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,