Struct SwaggerUi

pub struct SwaggerUi {
    pub path: &'static str,
    pub config: Config,
    /* private fields */
}

Set of endpoints serving a Swagger UI and the actual openapi files

Fields

path: &'static str

The path under which to serve the ui

config: Config

The config to use

Note: the urls field will be extended by the SwaggapiPages you added through SwaggerUi::page.

Implementations

impl SwaggerUi

pub fn without_everything() -> Self

Returns SwaggerUi::default but without including the PageOfEverything

pub fn with_path(path: &'static str) -> Self

Returns SwaggerUi::default with a given path

pub fn page(self, display_name: &'static str, page: impl SwaggapiPage) -> Self

Adds a SwaggapiPage to the ui

Trait Implementations

impl Default for SwaggerUi

fn default() -> Self

Normally the swagger ui is served under "/swagger-ui" and contains the PageOfEverything