Struct SwaggerUi

pub struct SwaggerUi {
    pub title: Cow<'static, str>,
    pub keywords: Option<Cow<'static, str>>,
    pub description: Option<Cow<'static, str>>,
    /* private fields */
}

Implements Handler for serving Swagger UI.

Fields

title: Cow<'static, str>

The title of the html page. The default title is “Swagger UI”.

keywords: Option<Cow<'static, str>>

The keywords of the html page.

description: Option<Cow<'static, str>>

The description of the html page.

Implementations

impl SwaggerUi

pub fn new(config: impl Into<Config<'static>>) -> SwaggerUi

Create a new SwaggerUi for given path.

Path argument will expose the Swagger UI to the user and should be something that the underlying application framework / library supports.

Examples

let swagger = SwaggerUi::new("/swagger-ui/{_:.*}");

pub fn title(self, title: impl Into<Cow<'static, str>>) -> SwaggerUi

Set title of the html page. The default title is “Swagger UI”.

pub fn keywords(self, keywords: impl Into<Cow<'static, str>>) -> SwaggerUi

Set keywords of the html page.

pub fn description(self, description: impl Into<Cow<'static, str>>) -> SwaggerUi

Set description of the html page.

pub fn url<U>(self, url: U) -> SwaggerUi

where U: Into<Url<'static>>,

Add api doc Url into SwaggerUi.

Calling this again will add another url to the Swagger UI.

Examples

let swagger = SwaggerUi::new("/api-doc/openapi.json")
    .url("/api-docs/openapi2.json");

pub fn urls(self, urls: Vec<Url<'static>>) -> SwaggerUi

Add multiple Urls to Swagger UI.

Takes one Vec argument containing tuples of Url and OpenApi.

Situations where this comes handy is when there is a need or wish to separate different parts of the api to separate api docs.

Examples

Expose multiple api docs via Swagger UI.

let swagger = SwaggerUi::new("/swagger-ui/{_:.*}")
    .urls(
      vec![
         (Url::with_primary("api doc 1", "/api-docs/openapi.json", true)),
         (Url::new("api doc 2", "/api-docs/openapi2.json"))
    ]
);

pub fn oauth(self, oauth: Config) -> SwaggerUi

Add oauth oauth::Config into SwaggerUi.

Method takes one argument which exposes the oauth::Config to the user.

Examples

Enable pkce with default client_id.

let swagger = SwaggerUi::new("/swagger-ui/{_:.*}")
    .url("/api-docs/openapi.json")
    .oauth(oauth::Config::new()
        .client_id("client-id")
        .scopes(vec![String::from("openid")])
        .use_pkce_with_authorization_code_grant(true)
    );

pub fn into_router(self, path: impl Into<String>) -> Router

Consusmes the SwaggerUi and returns Router with the SwaggerUi as handler.

Trait Implementations

impl Clone for SwaggerUi

fn clone(&self) -> SwaggerUi

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SwaggerUi

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

Formats the value using the given formatter.

impl Handler for SwaggerUi

fn handle<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, req: &'life1 mut Request, _depot: &'life2 mut Depot, res: &'life3 mut Response, _ctrl: &'life4 mut FlowCtrl, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, SwaggerUi: 'async_trait,

Handle http request.

fn arc(self) -> ArcHandler

where Self: Sized,

Wrap to ArcHandler.

fn hooped<H>(self) -> HoopedHandler

where H: Handler, Self: Sized,

Wrap to HoopedHandler.

fn hoop<H>(self, hoop: H) -> HoopedHandler

where H: Handler, Self: Sized,

Hoop this handler with middleware.

fn hoop_when<H, F>(self, hoop: H, filter: F) -> HoopedHandler

where Self: Sized, H: Handler, F: Fn(&Request, &Depot) -> bool + Send + Sync + 'static,

Hoop this handler with middleware.