Struct OpenApiSpec 

pub struct OpenApiSpec {
    pub spec: OpenAPI,
    pub file_path: Option<String>,
    pub raw_document: Option<Value>,
}

OpenAPI specification loader and parser

Fields

spec: OpenAPI

The parsed OpenAPI specification

file_path: Option<String>

Path to the original spec file

raw_document: Option<Value>

Raw OpenAPI document preserved as JSON for resolving unsupported constructs

Implementations

impl OpenApiSpec

pub async fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Load OpenAPI spec from a file path

pub fn from_string(content: &str, format: Option<&str>) -> Result<Self>

Load OpenAPI spec from string content

pub fn from_json(json: Value) -> Result<Self>

Load OpenAPI spec from JSON value

pub fn validate(&self) -> Result<()>

Validate the OpenAPI specification

pub fn version(&self) -> &str

Get the OpenAPI version

pub fn title(&self) -> &str

Get the API title

pub fn description(&self) -> Option<&str>

Get the API description

pub fn api_version(&self) -> &str

Get the API version

pub fn servers(&self) -> &[Server]

Get the server URLs

pub fn paths(&self) -> &Paths

Get all paths defined in the spec

pub fn schemas(&self) -> Option<&IndexMap<String, ReferenceOr<Schema>>>

Get all schemas defined in the spec

pub fn security_schemes( &self, ) -> Option<&IndexMap<String, ReferenceOr<SecurityScheme>>>

Get all security schemes defined in the spec

pub fn operations_for_path(&self, path: &str) -> HashMap<String, Operation>

Get all operations for a given path

pub fn all_paths_and_operations( &self, ) -> HashMap<String, HashMap<String, Operation>>

Get all paths with their operations

pub fn get_schema(&self, reference: &str) -> Option<OpenApiSchema>

Get a schema by reference

pub fn validate_security_requirements( &self, security_requirements: &[SecurityRequirement], auth_header: Option<&str>, api_key: Option<&str>, ) -> Result<()>

Validate security requirements

pub fn get_global_security_requirements(&self) -> Vec<SecurityRequirement>

Get global security requirements

pub fn get_request_body(&self, reference: &str) -> Option<&RequestBody>

Resolve a request body reference

pub fn get_response(&self, reference: &str) -> Option<&Response>

Resolve a response reference

pub fn get_example(&self, reference: &str) -> Option<&Example>

Resolve an example reference

Trait Implementations

impl Clone for OpenApiSpec

fn clone(&self) -> OpenApiSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiSpec

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

Formats the value using the given formatter.