pub struct ApiDocBuilder { /* private fields */ }
Expand description
API documentation builder
Implementations§
Source§impl ApiDocBuilder
impl ApiDocBuilder
pub fn new(title: &str, version: &str) -> Self
pub fn description(self, description: &str) -> Self
pub fn base_url(self, base_url: &str) -> Self
pub fn add_version(self, version: ApiVersion) -> Self
pub fn add_endpoint(self, endpoint: EndpointDoc) -> Self
Sourcepub fn generate_openapi(&self) -> Value
pub fn generate_openapi(&self) -> Value
Generate OpenAPI 3.0 specification
Sourcepub fn generate_html_docs(&self) -> String
pub fn generate_html_docs(&self) -> String
Generate simple HTML documentation
Trait Implementations§
Source§impl Clone for ApiDocBuilder
impl Clone for ApiDocBuilder
Source§fn clone(&self) -> ApiDocBuilder
fn clone(&self) -> ApiDocBuilder
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreAuto Trait Implementations§
impl Freeze for ApiDocBuilder
impl RefUnwindSafe for ApiDocBuilder
impl Send for ApiDocBuilder
impl Sync for ApiDocBuilder
impl Unpin for ApiDocBuilder
impl UnwindSafe for ApiDocBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more