Struct ReDoc

#[non_exhaustive]
pub struct ReDoc {
    pub title: Cow<'static, str>,
    pub keywords: Option<Cow<'static, str>>,
    pub description: Option<Cow<'static, str>>,
    pub lib_url: Cow<'static, str>,
    pub spec_url: Cow<'static, str>,
}

Available on crate feature redoc only.

Implements Handler for serving ReDoc.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

title: Cow<'static, str>

The title of the html page. The default title is “Scalar”.

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

The version of the html page.

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

The description of the html page.

lib_url: Cow<'static, str>

The lib url path.

spec_url: Cow<'static, str>

The spec url path.

Implementations

impl ReDoc

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

Create a new ReDoc for given path.

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

Examples

let doc = ReDoc::new("/openapi.json");

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

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

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 lib_url(self, lib_url: impl Into<Cow<'static, str>>) -> Self

Set the lib url path.

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

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

Trait Implementations

impl Clone for ReDoc

fn clone(&self) -> ReDoc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReDoc

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

Formats the value using the given formatter.

impl Handler for ReDoc

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 Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: '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.