Struct aide::openapi::v3::ui::ReDoc

pub struct ReDoc { /* fields omitted */ }

Implementations

impl ReDoc

pub fn new() -> Self

pub fn openapi_v3(self, api: &OpenApi) -> Self

Uses the given OpenAPI v3 document.

Panics

If an external URL is already set.

pub fn openapi_json(self, json: &str) -> Self

Uses the given OpenAPI v2 or v3 document already serialized as JSON.

Panics

If an external URL is already set.

pub fn api_at(self, url: &str) -> Self

Sets the path for the API document that will be used to serve the document. Both relative and absolute path are relative to where the ReDoc root is served from.

External URLs are allowed if there is no document given.

Defaults to api.json if there is a document provided, otherwise the official example Pet Store API is used.

Panics

If an external URL is given and there's a document provided.

pub fn actix_service(self, path: &str) -> Resource

Serve ReDoc in an Actix Web service at the given path. If a local document is set, it is also served.

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.