Struct salvo_oapi::OpenApi

#[non_exhaustive]
pub struct OpenApi {
    pub openapi: OpenApiVersion,
    pub info: Info,
    pub servers: BTreeSet<Server>,
    pub paths: Paths,
    pub components: Components,
    pub security: BTreeSet<SecurityRequirement>,
    pub tags: BTreeSet<Tag>,
    pub external_docs: Option<ExternalDocs>,
}

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 OpenApi::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)

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

OpenAPI document version.

info: Info

Provides metadata about the API.

See more details at https://spec.openapis.org/oas/latest.html#info-object.

servers: BTreeSet<Server>

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: 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: BTreeSet<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.

tags: BTreeSet<Tag>

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>

Global additional documentation reference.

See more details at https://spec.openapis.org/oas/latest.html#external-documentation-object.

Implementations

impl OpenApi

pub fn new(title: impl Into<String>, version: impl Into<String>) -> Self

Construct a new OpenApi object.

Examples

let openapi = OpenApi::new("pet api", "0.1.0");

pub fn with_info(info: Info) -> Self

Construct a new OpenApi object.

Function accepts Info metadata of the API;

Examples

let openapi = OpenApi::new("pet api", "0.1.0");

pub fn to_json(&self) -> Result<String, Error>

Converts this OpenApi to JSON String. This method essentially calls serde_json::to_string method.

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.

pub fn to_yaml(&self) -> Result<String, Error>

Available on crate feature yaml only.

Converts this OpenApi to YAML String. This method essentially calls serde_yaml::to_string method.

pub fn merge(self, other: OpenApi) -> Self

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 exists item will be overwrite.

For servers, tags and security_requirements the whole item will be used for comparison.

Note! info, openapi and external_docs will not be merged.

pub fn info<I: Into<Info>>(self, info: I) -> Self

Add Info metadata of the API.

pub fn servers<S: IntoIterator<Item = Server>>(self, servers: S) -> Self

Add iterator of Servers to configure target servers.

pub fn add_server<S>(self, server: S) -> Self

where S: Into<Server>,

Add Server to configure operations and endpoints of the API and returns Self.

pub fn paths<P: Into<Paths>>(self, paths: P) -> Self

Set paths to configure operations and endpoints of the API.

pub fn add_path<P, I>(self, path: P, item: I) -> Self

where P: Into<String>, I: Into<PathItem>,

Add PathItem to configure operations and endpoints of the API and returns Self.

pub fn components(self, components: impl Into<Components>) -> Self

Add Components to configure reusable schemas.

pub fn security<S: IntoIterator<Item = SecurityRequirement>>( self, security: S, ) -> Self

Add iterator of SecurityRequirements that are globally available for all operations.

pub fn add_security_scheme<N: Into<String>, S: Into<SecurityScheme>>( self, name: N, security_scheme: S, ) -> Self

Add SecurityScheme to Components and returns Self.

Accepts two arguments where first is the name of the SecurityScheme. This is later when referenced by SecurityRequirements. Second parameter is the SecurityScheme.

pub fn extend_security_schemes<I: IntoIterator<Item = (N, S)>, N: Into<String>, S: Into<SecurityScheme>>( self, schemas: I, ) -> Self

Add iterator of SecuritySchemes to Components.

Accepts two arguments where first is the name of the SecurityScheme. This is later when referenced by SecurityRequirements. Second parameter is the SecurityScheme.

pub fn add_schema<S: Into<String>, I: Into<RefOr<Schema>>>( self, name: S, schema: I, ) -> Self

Add Schema to Components and returns Self.

Accepts two arguments where first is name of the schema and second is the schema itself.

pub fn extend_schemas<I, C, S>(self, schemas: I) -> Self

where I: IntoIterator<Item = (S, C)>, C: Into<RefOr<Schema>>, S: Into<String>,

Add Schemas from iterator.

Examples

OpenApi::new("api", "0.0.1").extend_schemas([(
    "Pet",
    Schema::from(
        Object::new()
            .property(
                "name",
                Object::new().schema_type(SchemaType::String),
            )
            .required("name")
    ),
)]);

pub fn response<S: Into<String>, R: Into<RefOr<Response>>>( self, name: S, response: R, ) -> Self

Add a new response and returns self.

pub fn extend_responses<I: IntoIterator<Item = (S, R)>, S: Into<String>, R: Into<RefOr<Response>>>( self, responses: I, ) -> Self

Extends responses with the contents of an iterator.

pub fn tags<I, T>(self, tags: I) -> Self

where I: IntoIterator<Item = T>, T: Into<Tag>,

Add iterator of Tags to add additional documentation for operations tags.

pub fn external_docs(self, external_docs: ExternalDocs) -> Self

Add ExternalDocs for referring additional documentation.

pub fn into_router(self, path: impl Into<String>) -> Router

Consusmes the OpenApi and returns Router with the OpenApi as handler.

pub fn merge_router(self, router: &Router) -> Self

Consusmes the OpenApi and informations from a Router.

pub fn merge_router_with_base( self, router: &Router, base: impl AsRef<str>, ) -> Self

Consusmes the OpenApi and informations from a Router with base path.

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

fn handle<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, req: &'life1 mut Request, _depot: &'life2 mut Depot, res: &'life3 mut Response, _ctrl: &'life4 mut FlowCtrl, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait,

Handle http request.

impl PartialEq for OpenApi

fn eq(&self, other: &OpenApi) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for OpenApi