Struct utoipa::openapi::OpenApiBuilder

pub struct OpenApiBuilder { /* private fields */ }

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

Examples

Create OpenApi using OpenApiBuilder.

let openapi = OpenApiBuilder::new()
     .info(Info::new("My api", "1.0.0"))
     .paths(Paths::new())
     .components(Some(
         Components::new()
     ))
     .build();

Implementations

impl OpenApiBuilder

pub fn new() -> OpenApiBuilder

Constructs a new OpenApiBuilder.

pub fn build(self) -> OpenApi

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

impl OpenApiBuilder

pub fn info(self, info: Info) -> Self

Add Info metadata of the API.

pub fn servers<I: IntoIterator<Item = Server>>(self, servers: Option<I>) -> Self

Add iterator of Servers to configure target servers.

pub fn paths<P: Into<Paths>>(self, paths: P) -> Self

Add Paths to configure operations and endpoints of the API.

pub fn components(self, components: Option<Components>) -> Self

Add Components to configure reusable schemas.

pub fn security<I: IntoIterator<Item = SecurityRequirement>>(
    self,
    security: Option<I>
) -> Self

Add iterator of SecurityRequirements that are globally available for all operations.

pub fn tags<I: IntoIterator<Item = Tag>>(self, tags: Option<I>) -> Self

Add iterator of Tags to add additional documentation for operations tags.

pub fn external_docs(self, external_docs: Option<ExternalDocs>) -> Self

Add ExternalDocs for referring additional documentation.

Trait Implementations

impl Default for OpenApiBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<OpenApi> for OpenApiBuilder

fn from(value: OpenApi) -> Self

Converts to this type from the input type.

impl From<OpenApiBuilder> for OpenApi

fn from(value: OpenApiBuilder) -> Self

Converts to this type from the input type.