Struct utoipa_swagger_ui::Url

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

Rust type for Swagger UI url configuration object.

Implementations

impl<'a> Url<'a>

pub fn new(name: &'a str, url: &'a str) -> Self

Create new Url.

Name is shown in the select dropdown when there are multiple docs in Swagger UI.

Url is path which exposes the OpenAPI doc.

Examples

let url = Url::new("My Api", "/api-docs/openapi.json");

pub fn with_primary(name: &'a str, url: &'a str, primary: bool) -> Self

Create new Url with primary flag.

Primary flag allows users to override the default behavior of the Swagger UI for selecting the primary doc to display. By default when there are multiple docs in Swagger UI the first one in the list will be the primary.

Name is shown in the select dropdown when there are multiple docs in Swagger UI.

Url is path which exposes the OpenAPI doc.

Examples

Set “My Api” as primary.

let url = Url::with_primary("My Api", "/api-docs/openapi.json", true);

Trait Implementations

impl<'a> Clone for Url<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for Url<'a>

fn default() -> Url<'a>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl<'a> From<Cow<'static, str>> for Url<'a>

fn from(url: Cow<'static, str>) -> Self

Converts to this type from the input type.

impl From<String> for Url<'_>

fn from(url: String) -> Self

Converts to this type from the input type.

impl<'a> Serialize for Url<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.