Struct OpenApiSpec 

pub struct OpenApiSpec {
    pub info: Info,
    pub paths: BTreeMap<String, PathItem>,
    pub components: Option<Components>,
    pub servers: Vec<Server>,
    pub security: Vec<BTreeMap<String, Vec<String>>>,
}

Root OpenAPI 3.0 specification object.

Fields

info: Info

paths: BTreeMap<String, PathItem>

components: Option<Components>

servers: Vec<Server>

security: Vec<BTreeMap<String, Vec<String>>>

Implementations

impl OpenApiSpec

pub fn resolve_schema_ref(&self, ref_path: &str) -> Option<&Schema>

Look up a schema by $ref pointer like #/components/schemas/Foo.

pub fn resolve_parameter_ref(&self, ref_path: &str) -> Option<&Parameter>

Look up a parameter by $ref pointer like #/components/parameters/Foo.

pub fn resolve_request_body_ref(&self, ref_path: &str) -> Option<&RequestBody>

Look up a request body by $ref pointer.

pub fn resolve_response_ref(&self, ref_path: &str) -> Option<&Response>

Look up a response by $ref pointer.

impl OpenApiSpec

pub fn all_operations( &self, ) -> impl Iterator<Item = (String, String, &Operation)>

Iterate over every operation in the spec as (method, path, &Operation) triples.

pub fn schema_count(&self) -> usize

Returns the number of named schemas in components.schemas.

pub fn operation_count(&self) -> usize

Returns the total number of operations across all paths.

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenApiSpec

fn deserialize<__D>( __deserializer: __D, ) -> Result<OpenApiSpec, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OpenApiSpec

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

Formats the value using the given formatter.

impl Serialize for OpenApiSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.