Struct utoipa_swagger_ui::Config

#[non_exhaustive]
pub struct Config<'a> { /* private fields */ }

Object used to alter Swagger UI settings.

Examples

Simple case is to create config directly from url that points to the api doc json.

let config = Config::from("/api-doc.json");

If there is multiple api docs to serve config can be also directly created with Config::new

let config = Config::new(["/api-doc/openapi1.json", "/api-doc/openapi2.json"]);

Or same as above but more verbose syntax.

let config = Config::new([
    Url::new("api1", "/api-doc/openapi1.json"),
    Url::new("api2", "/api-doc/openapi2.json")
]);

With oauth config

let config = Config::with_oauth_config(
    ["/api-doc/openapi1.json", "/api-doc/openapi2.json"],
    oauth::Config::new(),
);

Implementations

impl<'a> Config<'a>

pub fn new<I: IntoIterator<Item = U>, U: Into<Url<'a>>>(urls: I) -> Self

Constructs a new Config from Iterator of Urls.

Examples

Create new config with 2 api doc urls.

let config = Config::new(["/api-doc/openapi1.json", "/api-doc/openapi2.json"]);

pub fn with_oauth_config<I: IntoIterator<Item = U>, U: Into<Url<'a>>>(
    urls: I,
    oauth_config: Config
) -> Self

Constructs a new Config from Iterator of Urls.

Examples

Create new config with oauth config

let config = Config::with_oauth_config(
    ["/api-doc/openapi1.json", "/api-doc/openapi2.json"],
    oauth::Config::new(),
);

Trait Implementations

impl<'a> Clone for Config<'a>

fn clone(&self) -> Config<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for Config<'a>

fn default() -> Config<'a>

Returns the “default value” for a type.

impl<'a> From<&'a str> for Config<'a>

fn from(s: &'a str) -> Self

Converts to this type from the input type.

impl From<String> for Config<'_>

fn from(s: String) -> Self

Converts to this type from the input type.