Struct OpenApiGenerator 

pub struct OpenApiGenerator { /* private fields */ }

Generates OpenAPI 3.0.3 specifications from SAMM Aspect Models.

Implementations

impl OpenApiGenerator

pub fn new(version: impl Into<String>, base_path: impl Into<String>) -> Self

Create a generator with the given API version and base path.

pub fn with_options(options: OpenApiOptions) -> Self

Create a generator from fully-specified OpenApiOptions.

pub fn with_post(self) -> Self

Enable a POST endpoint in the generated spec.

pub fn with_put(self) -> Self

Enable a PUT endpoint in the generated spec.

pub fn with_delete(self) -> Self

Enable a DELETE endpoint in the generated spec.

pub fn generate(&self, aspect: &Aspect) -> Result<Value>

Generate an OpenAPI 3.0.3 specification Value for the given aspect.

pub fn build_schemas(&self, aspect: &Aspect) -> Result<Value>

Build the components/schemas mapping.

Trait Implementations

impl Clone for OpenApiGenerator

fn clone(&self) -> OpenApiGenerator

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenApiGenerator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.