Struct utoipa::openapi::schema::ComponentsBuilder

pub struct ComponentsBuilder { /* private fields */ }

Builder for Components with chainable configuration methods to create a new Components.

Implementations

impl ComponentsBuilder

pub fn new() -> ComponentsBuilder

Constructs a new ComponentsBuilder.

pub fn build(self) -> Components

Constructs a new Components taking all fields values from this object.

impl ComponentsBuilder

pub fn component<S: Into<String>, I: Into<Component>>(
    self,
    name: S,
    component: I
) -> Self

Add Component to Components.

Accpets two arguments where first is name of the component and second is the component itself.

pub fn security_scheme<N: Into<String>, S: Into<SecurityScheme>>(
    self,
    name: N,
    security_schema: S
) -> Self

Add SecurityScheme to Components.

Accepts two arguments where first is the name of the SecurityScheme. This is later when referenced by SecurityRequirements. Second parameter is the SecurityScheme.

Trait Implementations

impl Default for ComponentsBuilder

fn default() -> ComponentsBuilder

Returns the “default value” for a type.

impl From<Components> for ComponentsBuilder

fn from(value: Components) -> Self

Converts to this type from the input type.

impl From<ComponentsBuilder> for Components

fn from(value: ComponentsBuilder) -> Self

Converts to this type from the input type.