Struct OpenAPI

pub struct OpenAPI {

    pub swagger: String,
    pub info: Info,
    pub host: Option<String>,
    pub base_path: Option<String>,
    pub schemes: Option<Vec<Scheme>>,
    pub consumes: Option<Vec<String>>,
    pub produces: Option<Vec<String>>,
    pub tags: Option<Vec<Tag>>,
    pub paths: IndexMap<String, PathItem>,
    pub definitions: Option<IndexMap<String, Schema>>,
    pub parameters: Option<IndexMap<String, Parameter>>,
    pub responses: Option<IndexMap<String, Response>>,
    pub security_definitions: Option<IndexMap<String, Security>>,
    pub security: Option<Vec<IndexMap<String, Vec<String>>>>,
    pub external_docs: Option<Vec<ExternalDoc>>,
}

Available on crate feature v2 only.

top level document

Fields

swagger: String

The Swagger version of this document.

info: Info

host: Option<String>

The host (name or ip) of the API. Example: ‘swagger.io’ ^[^{}/ :\\]+(?::\d+)?$

base_path: Option<String>

The base path to the API. Example: ‘/api’.

schemes: Option<Vec<Scheme>>

consumes: Option<Vec<String>>

A list of MIME types accepted by the API.

produces: Option<Vec<String>>

A list of MIME types the API can produce.

tags: Option<Vec<Tag>>

paths: IndexMap<String, PathItem>

Relative paths to the individual endpoints. They must be relative to the ‘basePath’.

definitions: Option<IndexMap<String, Schema>>

parameters: Option<IndexMap<String, Parameter>>

responses: Option<IndexMap<String, Response>>

mappings to http response codes or “default”

security_definitions: Option<IndexMap<String, Security>>

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

external_docs: Option<Vec<ExternalDoc>>

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

Formats the value using the given formatter.

impl Default for OpenAPI

fn default() -> OpenAPI

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Into<OpenAPI> for OpenAPI

fn into(self) -> OpenAPI

Converts this type into the (usually inferred) input type.

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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OpenAPI