Struct 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.

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

pub fn schema_from<I: ToSchema>(self) -> Self

Add Schema to Components.

This is effectively same as calling ComponentsBuilder::schema but expects to be called with one generic argument that implements ToSchema trait.

Examples

Add schema from Value type that derives ToSchema.

 #[derive(ToSchema)]
 struct Value(String);

 let _ = ComponentsBuilder::new().schema_from::<Value>().build();

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(Type::String),
            )
            .required("name")
    ),
)]);

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

Add Response to Components.

Method accepts tow arguments; name of the reusable response and response which is the reusable response itself.

pub fn response_from<'r, I: ToResponse<'r>>(self) -> Self

Add Response to Components.

This behaves the same way as ComponentsBuilder::schema_from but for responses. It allows adding response from type implementing ToResponse trait. Method is expected to be called with one generic argument that implements the trait.

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

Add multiple Responses to Components from iterator.

Like the ComponentsBuilder::schemas_from_iter this allows adding multiple responses by any iterator what returns tuples of (name, response) values.

pub fn security_scheme<N: Into<String>, S: Into<SecurityScheme>>( self, name: N, security_scheme: 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.

pub fn extensions(self, extensions: Option<Extensions>) -> Self

Add openapi extensions (x-something) of the API.

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.