Struct OpenApi 

pub struct OpenApi {
    pub openapi: OpenApiVersion,
    pub info: Info,
    pub servers: Option<Vec<Server>>,
    pub paths: BTreeMap<String, PathItem>,
    pub components: Option<Components>,
    pub security: Option<Vec<HashMap<String, Vec<String>>>>,
    pub tags: Option<Vec<Tag>>,
    pub external_docs: Option<ExternalDocumentation>,
}

OpenAPI document (root structure)

Fields

openapi: OpenApiVersion

OpenAPI version

info: Info

API information

servers: Option<Vec<Server>>

Server list

paths: BTreeMap<String, PathItem>

Path definitions

components: Option<Components>

Components (reusable components)

security: Option<Vec<HashMap<String, Vec<String>>>>

Security requirements

tags: Option<Vec<Tag>>

Tag definitions

external_docs: Option<ExternalDocumentation>

External documentation

Implementations

impl OpenApi

pub fn merge(&mut self, other: OpenApi)

Merge another OpenAPI document into this one. Paths, schemas, and tags from other are added to self. If there are conflicts, self takes precedence.

pub fn merge_from_str(&mut self, json_str: &str) -> Result<(), Error>

Merge from a JSON string. Returns error if parsing fails.

Trait Implementations

impl Clone for OpenApi

fn clone(&self) -> OpenApi

Returns a duplicate 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<'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 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.