Struct salvo_oapi::Info

#[non_exhaustive]
pub struct Info {
    pub title: String,
    pub description: Option<String>,
    pub terms_of_service: Option<String>,
    pub contact: Option<Contact>,
    pub license: Option<License>,
    pub version: String,
}

Examples

Create Info].

let info = Info::new("My api", "1.0.0").contact(Contact::new()
    .name("Admin Admin")
    .email("amdin@petapi.com")
);

OpenAPI Info object represents metadata of the API.

You can use Info::new to construct a new Info 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.

title: String

Title of the API.

description: Option<String>

Optional description of the API.

Value supports markdown syntax.

terms_of_service: Option<String>

Optional url for terms of service.

contact: Option<Contact>

Contact information of exposed API.

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

license: Option<License>

License of the API.

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

version: String

Document version typically the API version.

Implementations

impl Info

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

Construct a new Info object.

This function accepts two arguments. One which is the title of the API and two the version of the api document typically the API version.

Examples

let info = Info::new("Pet api", "1.1.0");

pub fn title<I: Into<String>>(self, title: I) -> Self

Add title of the API.

pub fn version<I: Into<String>>(self, version: I) -> Self

Add version of the api document typically the API version.

pub fn description<S: Into<String>>(self, description: S) -> Self

Add description of the API.

pub fn terms_of_service<S: Into<String>>(self, terms_of_service: S) -> Self

Add url for terms of the API.

pub fn contact(self, contact: Contact) -> Self

Add contact information of the API.

pub fn license(self, license: License) -> Self

Add license of the API.

Trait Implementations

impl Clone for Info

fn clone(&self) -> Info

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Info

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Info

fn default() -> Info

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Info

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Info> for Info

fn eq(&self, other: &Info) -> 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 Info

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Info

impl StructuralEq for Info

impl StructuralPartialEq for Info