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 schema<S: Into<String>, I: Into<RefOr<Schema>>>(
    self,
    name: S,
    schema: I
) -> Self

Add Schema to Components.

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

pub fn schemas_from_iter<I: IntoIterator<Item = (S, C)>, C: Into<RefOr<Schema>>, S: Into<String>>(
    self,
    schemas: I
) -> Self

Add Schemas from iterator.

Examples

ComponentsBuilder::new().schemas_from_iter([(
    "Pet",
    Schema::from(
        ObjectBuilder::new()
            .property(
                "name",
                ObjectBuilder::new().schema_type(SchemaType::String),
            )
            .required("name")
    ),
)]);

pub fn response<S: Into<String>, R: Into<RefOr<Response>>>(
    self,
    name: S,
    response: R
) -> Self

pub fn response_from_into<I: ToResponse>(self) -> Self

pub fn responses_from_iter<I: IntoIterator<Item = (S, R)>, S: Into<String>, R: Into<RefOr<Response>>>(
    self,
    responses: I
) -> Self

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() -> Self

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.