Struct OpenAPIGenerator 

pub struct OpenAPIGenerator { /* private fields */ }

Implementations

impl OpenAPIGenerator

pub fn new() -> Self

pub fn with_info(self, info: Value) -> Self

pub fn register_path(&mut self, path: &str, info: PathInfo) -> &mut Self

Registers a (path, method) operation. Multiple methods for the same path are merged into the same paths entry.

pub fn register_schema(&mut self, name: &str, schema: Schema) -> &mut Self

Registers a reusable Schema definition

pub fn register_security_scheme( &mut self, name: &str, scheme: SecurityScheme, ) -> &mut Self

Registers a reusable SecurityScheme

pub fn add_tag(&mut self, tag: Tag) -> &mut Self

Adds an interface grouping tag

pub fn add_server(&mut self, server: Server) -> &mut Self

Adds an environment server

pub fn with_global_security(self, req: SecurityRequirement) -> Self

Sets the global security requirement

pub fn generate(&self) -> OpenAPISpec

Generates the OpenAPISpec

Trait Implementations

impl Default for OpenAPIGenerator

fn default() -> Self

Returns the “default value” for a type.