Struct aide::openapi::v3::definition::OpenApi

pub struct OpenApi {
    pub openapi: String,
    pub info: Info,
    pub servers: Vec<Server>,
    pub paths: Map<String, PathItem>,
    pub components: Option<Components>,
    pub security: Vec<Map<String, Vec<String>>>,
    pub tags: Vec<Tag>,
    pub external_docs: Option<ExternalDocs>,
    pub extensions: Map<String, Value>,
}

Fields

openapi: String

info: Info

servers: Vec<Server>

paths: Map<String, PathItem>

components: Option<Components>

security: Vec<Map<String, Vec<String>>>

tags: Vec<Tag>

external_docs: Option<ExternalDocs>

extensions: Map<String, Value>

Implementations

impl OpenApi

pub fn transform<T: FnOnce(Self) -> Self>(self, transform_fn: T) -> Self

Allows applying transform functions in a neat way.

pub fn try_transform<T: FnOnce(Self) -> Result<Self, E>, E: Error>(
    self,
    transform_fn: T
) -> Result<Self, E>

Same as transform, however allows for fallible operations that might return an error.

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

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 JsonSchema for OpenApi

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

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.