pub struct OpenApiGenerator { /* private fields */ }Expand description
Main OpenAPI specification generator
Implementations§
Source§impl OpenApiGenerator
impl OpenApiGenerator
Sourcepub fn new(config: OpenApiConfig) -> Self
pub fn new(config: OpenApiConfig) -> Self
Create a new OpenAPI generator
Sourcepub fn generate(
&mut self,
routes: &[RouteMetadata],
) -> OpenApiResult<&OpenApiSpec>
pub fn generate( &mut self, routes: &[RouteMetadata], ) -> OpenApiResult<&OpenApiSpec>
Generate OpenAPI specification from route metadata
Sourcepub fn export_json(&self, pretty: bool) -> OpenApiResult<String>
pub fn export_json(&self, pretty: bool) -> OpenApiResult<String>
Export specification as JSON
Sourcepub fn export_yaml(&self) -> OpenApiResult<String>
pub fn export_yaml(&self) -> OpenApiResult<String>
Export specification as YAML
Sourcepub fn specification(&self) -> Option<&OpenApiSpec>
pub fn specification(&self) -> Option<&OpenApiSpec>
Get the generated specification
Sourcepub fn validate(&self) -> OpenApiResult<()>
pub fn validate(&self) -> OpenApiResult<()>
Validate the generated specification
Auto Trait Implementations§
impl Freeze for OpenApiGenerator
impl RefUnwindSafe for OpenApiGenerator
impl Send for OpenApiGenerator
impl Sync for OpenApiGenerator
impl Unpin for OpenApiGenerator
impl UnwindSafe for OpenApiGenerator
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