#[non_exhaustive]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<SecurityRequirement>>,
pub tags: Option<Vec<Tag>>,
pub external_docs: Option<ExternalDocs>,
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.openapi: OpenApiVersion
info: Info
servers: Option<Vec<Server>>
paths: BTreeMap<String, PathItem>
components: Option<Components>
security: Option<Vec<SecurityRequirement>>
external_docs: Option<ExternalDocs>
Implementations
sourceimpl OpenApi
impl OpenApi
pub fn new(info: Info, paths: Paths) -> Self
pub fn with_servers<I: IntoIterator<Item = Server>>(self, servers: I) -> Self
pub fn with_components(self, components: Components) -> Self
sourcepub fn with_securities<I: IntoIterator<Item = SecurityRequirement>>(
self,
securities: I
) -> Self
pub fn with_securities<I: IntoIterator<Item = SecurityRequirement>>(
self,
securities: I
) -> Self
Add list of SecurityRequirement
s that are globally available for all operations.
sourcepub fn with_security(self, security: SecurityRequirement) -> Self
pub fn with_security(self, security: SecurityRequirement) -> Self
Add SecurityRequirement
that is globally available for all operations.
pub fn to_json(&self) -> Result<String, Error>
pub fn to_pretty_json(&self) -> Result<String, Error>
Trait Implementations
sourceimpl<'de> Deserialize<'de> for OpenApi
impl<'de> Deserialize<'de> for OpenApi
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl RefUnwindSafe for OpenApi
impl Send for OpenApi
impl Sync for OpenApi
impl Unpin for OpenApi
impl UnwindSafe for OpenApi
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
🔬 This is a nightly-only experimental API. (
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more