Struct OpenAPI

pub struct OpenAPI {
    pub openapi: String,
    pub info: Info,
    pub servers: Vec<Server>,
    pub paths: Paths,
    pub components: Components,
    pub security: Vec<IndexMap<String, Vec<String>>>,
    pub tags: Vec<Tag>,
    pub external_docs: Option<ExternalDocumentation>,
    pub extensions: IndexMap<String, Value>,
}

Fields

openapi: String

REQUIRED. This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses. The openapi field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is not related to the API info.version string.

info: Info

REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.

servers: Vec<Server>

An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.

paths: Paths

REQUIRED. The available paths and operations for the API.

components: Components

An element to hold various schemas for the specification.

security: Vec<IndexMap<String, Vec<String>>>

A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. Global security settings may be overridden on a per-path basis.

tags: Vec<Tag>

A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tool’s logic. Each tag name in the list MUST be unique.

external_docs: Option<ExternalDocumentation>

Additional external documentation.

extensions: IndexMap<String, Value>

Inline extensions to this object.

Implementations

impl OpenAPI

pub fn operations( &self, ) -> impl Iterator<Item = (&str, &str, &Operation, &PathItem)>

Iterates through all Operations in this API.

The iterated items are tuples of (&str, &str, &Operation, &PathItem) containing the path, method, and the operation.

Path items containing $refs are skipped.

pub fn operations_mut( &mut self, ) -> impl Iterator<Item = (&str, &str, &mut Operation)>

pub fn get_operation_mut( &mut self, operation_id: &str, ) -> Option<&mut Operation>

pub fn get_operation( &self, operation_id: &str, ) -> Option<(&Operation, &PathItem)>

pub fn merge(self, other: OpenAPI) -> Result<OpenAPI, MergeError>

Merge another OpenAPI document into this one, keeping original schemas on conflict. a.merge(b) will have all schemas from a and b, but keep a for any duplicates.

pub fn merge_overwrite(self, other: OpenAPI) -> Result<OpenAPI, MergeError>

Merge another OpenAPI document into this one, replacing any duplicate schemas. a.merge_overwrite(b) will have all schemas from a and b, but keep b for any duplicates.

Methods from Deref<Target = Components>

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for OpenAPI

fn clone(&self) -> OpenAPI

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAPI

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

Formats the value using the given formatter.

impl Default for OpenAPI

fn default() -> OpenAPI

Returns the “default value” for a type.

impl Deref for OpenAPI

type Target = Components

The resulting type after dereferencing.

fn deref(&self) -> &<OpenAPI as Deref>::Target

Dereferences the value.

impl DerefMut for OpenAPI

fn deref_mut(&mut self) -> &mut <OpenAPI as Deref>::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for OpenAPI

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OpenAPI

fn eq(&self, other: &OpenAPI) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OpenAPI

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.

impl StructuralPartialEq for OpenAPI