Struct OpenApiConfig 

pub struct OpenApiConfig {
    pub openapi_version: String,
    pub info: ApiInfo,
    pub servers: Vec<ServerConfig>,
    pub security_schemes: HashMap<String, SecurityScheme>,
    pub tags: Vec<TagConfig>,
    pub external_docs: Option<ExternalDocs>,
    pub include_examples: bool,
    pub nullable_optional: bool,
    pub custom_schemas: HashMap<String, String>,
    pub export: ExportConfig,
}

Configuration for OpenAPI specification generation

Fields

openapi_version: String

OpenAPI specification version (should be “3.0.3”)

info: ApiInfo

API information

servers: Vec<ServerConfig>

Server configurations

security_schemes: HashMap<String, SecurityScheme>

Global security schemes

tags: Vec<TagConfig>

Global tags for grouping operations

external_docs: Option<ExternalDocs>

External documentation

include_examples: bool

Whether to include example values in schemas

nullable_optional: bool

Whether to generate nullable fields for Option

custom_schemas: HashMap<String, String>

Custom schema mappings for specific types

export: ExportConfig

Export settings

Implementations

impl OpenApiConfig

pub fn new(title: &str, version: &str) -> Self

Create a new configuration with custom API info

pub fn add_server(self, url: &str, description: Option<&str>) -> Self

Add a server configuration

pub fn add_security_scheme(self, name: &str, scheme: SecurityScheme) -> Self

Add a security scheme

pub fn add_tag(self, name: &str, description: Option<&str>) -> Self

Add a tag

Trait Implementations

impl Clone for OpenApiConfig

fn clone(&self) -> OpenApiConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenApiConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OpenApiConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpenApiConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OpenApiConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.