Struct utoipa::openapi::info::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,
}

OpenAPI Info object represents metadata of the API.

You can use Info::new to construct a new Info object or alternatively use InfoBuilder::new to construct a new Info with chainable configuraiton methods.

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<S: Into<String>>(title: S, version: S) -> 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");

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 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 From<Info> for InfoBuilder

fn from(value: Info) -> Self

Converts to this type from the input type.

impl From<InfoBuilder> for Info

fn from(value: InfoBuilder) -> Self

Converts to this type from the input type.

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.