Struct hypers_openapi::SwaggerUi

pub struct SwaggerUi {
    pub config: Config<'static>,
    pub title: Cow<'static, str>,
    pub keywords: Option<Cow<'static, str>>,
    pub description: Option<Cow<'static, str>>,
}

Implements [Handler] for serving Swagger UI.

Fields

config: Config<'static>

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>>) -> Self

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>>) -> Self

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

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

Set keywords of the html page.

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

Set description of the html page.

pub fn url<U: Into<Url<'static>>>(self, url: U) -> Self

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>>) -> Self

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: OauthConfig) -> Self

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(OauthConfig::new()
        .client_id("client-id")
        .scopes(vec![String::from("openid")])
        .use_pkce_with_authorization_code_grant(true)
    );

pub fn serve<'a>( path: &str, title: &str, keywords: &str, description: &str, config: &Config<'a>, ) -> Result<Option<SwaggerFile<'a>>, Error>

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

Formats the value using the given formatter.