Struct utoipa_rapidoc::RapiDoc

#[non_exhaustive]
pub struct RapiDoc { /* private fields */ }

Is RapiDoc UI.

This is an entry point for serving RapiDoc via predefined framework integration or in standalone fashion by calling RapiDoc::to_html within custom HTTP handler handles serving the RapiDoc UI. See more at running standalone

Implementations

impl RapiDoc

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

Construct a new RapiDoc that points to given spec_url. Spec url must be valid URL and available for RapiDoc to consume.

Examples

Create new RapiDoc.

RapiDoc::new("https://petstore3.swagger.io/api/v3/openapi.json");

pub fn with_openapi<U: Into<Cow<'static, str>>>( spec_url: U, openapi: OpenApi ) -> Self

Available on crate features actix-web or rocket or axum only.

Construct a new RapiDoc with given spec_url and openapi. The spec url must point to the location where the openapi will be served.

RapiDoc is only able to create endpoint that serves the openapi JSON for predefined frameworks. For other frameworks such endpoint must be created manually.

Examples

Create new RapiDoc.

RapiDoc::with_openapi(
    "/api-docs/openapi.json",
    ApiDoc::openapi()
);

pub fn custom_html<H: Into<Cow<'static, str>>>(self, html: H) -> Self

Override the default HTML template with new one. See customization for more details.

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

Add path the RapiDoc will be served from.

Examples

Make RapiDoc servable from /rapidoc path.

RapiDoc::new("https://petstore3.swagger.io/api/v3/openapi.json")
    .path("/rapidoc");

pub fn to_html(&self) -> String

Converts this RapiDoc instance to servable HTML file.

This will replace $specUrl variable placeholder with the spec url provided to the RapiDoc instance. If HTML template is not overridden with RapiDoc::custom_html then the default HTML template will be used.

See more details in customization.

Trait Implementations

impl<R> From<RapiDoc> for Router<R>

where R: Clone + Send + Sync + 'static,

fn from(value: RapiDoc) -> Self

Converts to this type from the input type.

impl From<RapiDoc> for Vec<Route>

fn from(value: RapiDoc) -> Self

Converts to this type from the input type.

impl HttpServiceFactory for RapiDoc

fn register(self, config: &mut AppService)