#[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
sourceimpl 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. 1
json feature is needed. ↩
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. 1
json feature is needed. ↩