pub struct OpenApi {
pub openapi: OpenApiVersion,
pub info: Info,
pub servers: Vec<Server>,
pub paths: Paths,
pub components: Option<Components>,
pub security: Vec<SecurityRequirement>,
pub tags: Vec<Tag>,
pub external_docs: Option<ExternalDocumentation>,
pub extensions: IndexMap<String, Value>,
}
Expand description
This is the root document object of the OpenAPI document.
Fields§
§openapi: OpenApiVersion
This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses. The openapi
field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is not related to the API info.version
string.
info: Info
Provides metadata about the API. The metadata MAY be used by tooling as required.
servers: Vec<Server>
An array of Server Objects, which provide connectivity information to a target server. If the servers
property is not provided, or is an empty array, the default value would be a Server Object with a url value of /
.
paths: Paths
The available paths and operations for the API.
components: Option<Components>
An element to hold various schemas for the specification.
security: Vec<SecurityRequirement>
A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. To make security optional, an empty security requirement ({}
) can be included in the array.
A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools’ logic. Each tag name in the list MUST be unique.
external_docs: Option<ExternalDocumentation>
Additional external documentation.
extensions: IndexMap<String, Value>
This object MAY be extended with Specification Extensions.
Trait Implementations§
source§impl<'de> Deserialize<'de> for OpenApi
impl<'de> Deserialize<'de> for OpenApi
source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<OpenApi, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<OpenApi, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
source§impl PartialEq for OpenApi
impl PartialEq for OpenApi
source§impl Serialize for OpenApi
impl Serialize for OpenApi
source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
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
)