#[non_exhaustive]pub struct OpenApi {
pub openapi: OpenApiVersion,
pub info: Info,
pub servers: Option<Vec<Server>>,
pub paths: Paths,
pub components: Option<Components>,
pub security: Option<Vec<SecurityRequirement>>,
pub tags: Option<Vec<Tag>>,
pub external_docs: Option<ExternalDocs>,
}
Expand description
Root object of the OpenAPI document.
You can use OpenApi::new
function to construct a new OpenApi
instance and then
use the fields with mutable access to modify them. This is quite tedious if you are not simply
just changing one thing thus you can also use the OpenApiBuilder::new
to use builder to
construct a new OpenApi
object.
See more details at https://spec.openapis.org/oas/latest.html#openapi-object.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.openapi: OpenApiVersion
OpenAPI document version.
info: Info
Provides metadata about the API.
See more details at https://spec.openapis.org/oas/latest.html#info-object.
servers: Option<Vec<Server>>
Optional list of servers that provides the connectivity information to target servers.
This is implicitly one server with url
set to /
.
See more details at https://spec.openapis.org/oas/latest.html#server-object.
paths: Paths
Available paths and operations for the API.
See more details at https://spec.openapis.org/oas/latest.html#paths-object.
components: Option<Components>
Holds various reusable schemas for the OpenAPI document.
Few of these elements are security schemas and object schemas.
See more details at https://spec.openapis.org/oas/latest.html#components-object.
security: Option<Vec<SecurityRequirement>>
Declaration of global security mechanisms that can be used across the API. The individual operations
can override the declarations. You can use SecurityRequirement::default()
if you wish to make security
optional by adding it to the list of securities.
See more details at https://spec.openapis.org/oas/latest.html#security-requirement-object.
Optional list of tags can be used to add additional documentation to matching tags of operations.
See more details at https://spec.openapis.org/oas/latest.html#tag-object.
external_docs: Option<ExternalDocs>
Optional global additional documentation reference.
See more details at https://spec.openapis.org/oas/latest.html#external-documentation-object.
Implementations§
source§impl OpenApi
impl OpenApi
sourcepub fn to_json(&self) -> Result<String, Error>
pub fn to_json(&self) -> Result<String, Error>
Converts this OpenApi
to JSON String. This method essentially calls serde_json::to_string
method.
sourcepub fn to_pretty_json(&self) -> Result<String, Error>
pub fn to_pretty_json(&self) -> Result<String, Error>
Converts this OpenApi
to pretty JSON String. This method essentially calls serde_json::to_string_pretty
method.
sourcepub fn merge(&mut self, other: OpenApi)
pub fn merge(&mut self, other: OpenApi)
Merge other
OpenApi
consuming it and resuming it’s content.
Merge function will take all self
nonexistent servers
, paths
, schemas
, responses
,
security_schemes
, security_requirements
and tags
from other
OpenApi
.
This function performs a shallow comparison for paths
, schemas
, responses
and
security schemes
which means that only name
and path
is used for comparison. When
match occurs the whole item will be ignored from merged results. Only items not
found will be appended to self
.
For servers
, tags
and security_requirements
the whole item will be used for
comparison. Items not found from self
will be appended to self
.
Note! info
, openapi
and external_docs
will not be merged.
Trait Implementations§
source§impl<'de> Deserialize<'de> for OpenApi
impl<'de> Deserialize<'de> for OpenApi
source§fn 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>,
source§impl From<OpenApi> for OpenApiBuilder
impl From<OpenApi> for OpenApiBuilder
source§impl From<OpenApiBuilder> for OpenApi
impl From<OpenApiBuilder> for OpenApi
source§fn from(value: OpenApiBuilder) -> Self
fn from(value: OpenApiBuilder) -> Self
source§impl PartialEq for OpenApi
impl PartialEq for OpenApi
impl StructuralPartialEq for OpenApi
Auto Trait Implementations§
impl Freeze for OpenApi
impl RefUnwindSafe for OpenApi
impl Send for OpenApi
impl Sync for OpenApi
impl Unpin for OpenApi
impl UnwindSafe for OpenApi
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)