Struct 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 openapi(self, openapi: OpenApiVersion) -> Self

Set the OpenApiVersion the document serializes as.

Defaults to OpenApiVersion::Version31. Set OpenApiVersion::Version32 to opt in to OpenAPI 3.2 output.

Examples

Opt in to OpenAPI 3.2 output.

let openapi = OpenApiBuilder::new()
    .openapi(OpenApiVersion::Version32)
    .info(Info::new("my api", "0.1.0"))
    .build();

pub fn info<I: Into<Info>>(self, info: I) -> 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 webhooks<P: Into<Paths>>(self, webhooks: Option<P>) -> Self

Add Paths to describe incoming requests that may be initiated by the API provider.

Examples

Describe a newPet webhook that the API provider may send to a subscriber.

let openapi = OpenApiBuilder::new()
    .info(Info::new("Events API", "1.0.0"))
    .paths(Paths::new())
    .webhooks(Some(PathsBuilder::new().path(
        "newPet",
        PathItem::new(
            HttpMethod::Post,
            OperationBuilder::new().response("200", Response::new("Webhook received")),
        ),
    )))
    .build();

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.

pub fn schema<S: Into<String>>(self, schema: S) -> Self

Override default $schema dialect for the Open API doc.

Examples

Override default schema dialect.

let _ = OpenApiBuilder::new()
    .schema("http://json-schema.org/draft-07/schema#")
    .build();

pub fn json_schema_dialect<S: Into<String>>( self, json_schema_dialect: Option<S>, ) -> Self

Add or change the default JSON Schema dialect for Schema Objects.

Examples

let _ = OpenApiBuilder::new()
    .json_schema_dialect(Some("https://spec.openapis.org/oas/3.2/dialect/2025-09-17"))
    .build();

pub fn self_uri<S: Into<String>>(self, self_uri: Option<S>) -> Self

Add or change the URI identifying this OpenAPI document.

Examples

let _ = OpenApiBuilder::new()
    .self_uri(Some("https://example.com/openapi.json"))
    .build();

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.