[−][src]Struct aide::openapi::v3::ui::ReDoc
Implementations
impl ReDoc
[src]
pub fn new() -> Self
[src]
pub fn openapi_v3(self, api: &OpenApi) -> Self
[src]
Uses the given OpenAPI v3 document.
Panics
If an external URL is already set.
pub fn openapi_json(self, json: &str) -> Self
[src]
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
[src]
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
[src]
Serve ReDoc in an Actix Web service at the given path. If a local document is set, it is also served.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for ReDoc
impl Send for ReDoc
impl Sync for ReDoc
impl Unpin for ReDoc
impl UnwindSafe for ReDoc
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DynClone for T where
T: Clone,
[src]
T: Clone,
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,