Struct OpenApiBuilder

pub struct OpenApiBuilder { /* private fields */ }

OpenAPI specificatrion builder.

Implementations

impl OpenApiBuilder

pub fn new(title: &str, version: &str) -> Self

Create new builder with specified title and version

pub fn set_components(&mut self, new_components: Components) -> &mut Self

Alter default Components.

NOTE

This will override existing components in builder. Use this before adding anything to the builder.

pub fn try_operation<T>( &mut self, path: T, method: Method, generator: OperationGenerator, ) -> Result<&mut Self, Error>

where T: Into<String>,

Add single operation.

Throws an error if (path, method) pair is already present.

pub fn try_operations<I, S>( &mut self, operations: I, ) -> Result<&mut Self, Error>

where I: Iterator<Item = (S, Method, OperationGenerator)>, S: Into<String>,

Add multiple operations.

Throws an error if any (path, method) pair is already present.

pub fn operation<T>( &mut self, path: T, method: Method, generator: OperationGenerator, ) -> &mut Self

where T: Into<String>,

Add single operation.

Replaces operation if (path, method) pair is already present.

pub fn operations<I, S>(&mut self, operations: I) -> &mut Self

where I: Iterator<Item = (S, Method, OperationGenerator)>, S: Into<String>,

Add multiple operations.

Replaces operation if (path, method) pair is already present.

pub fn spec_mut(&mut self) -> &mut OpenApi

Access inner okapi::openapi3::OpenApi.

Warning! This allows raw access to underlying OpenApi object, which might break generated specification.

NOTE

Components are overwritten on building specification.

pub fn apply_global_security<N, S>(&mut self, name: N, scopes: S) -> &mut Self

where N: Into<String>, S: IntoIterator<Item = String>,

Apply security scheme globally.

pub fn build(&mut self) -> Result<OpenApi, Error>

Generate okapi::openapi3::OpenApi specification.

This method can be called repeatedly on the same object.

pub fn title(&mut self, title: impl Into<String>) -> &mut Self

Set specification title.

Empty string by default.

pub fn version(&mut self, version: impl Into<String>) -> &mut Self

Set specification version.

Empty string by default.

pub fn description(&mut self, description: impl Into<String>) -> &mut Self

Add description to specification.

pub fn contact(&mut self, contact: Contact) -> &mut Self

Add contact to specification.

pub fn license(&mut self, license: License) -> &mut Self

Add license to specification.

pub fn terms_of_service( &mut self, terms_of_service: impl Into<String>, ) -> &mut Self

Add terms_of_service to specification.

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

Add server to specification.

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

Add tag to specification.

pub fn external_docs(&mut self, docs: ExternalDocs) -> &mut Self

Set external documentation for specification.

pub fn security_scheme<N>(&mut self, name: N, sec: SecurityScheme) -> &mut Self

where N: Into<String>,

Add security scheme definition to specification.

Trait Implementations

impl Clone for OpenApiBuilder

fn clone(&self) -> OpenApiBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for OpenApiBuilder

fn default() -> Self

Returns the “default value” for a type.