Struct Info 

pub struct Info {
    pub title: String,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub terms_of_service: Option<String>,
    pub contact: Option<Contact>,
    pub license: Option<License>,
    pub version: String,
    pub extensions: Extensions,
}

Metadata about the API.

Fields

title: String

The title of the API.

summary: Option<String>

A short summary of the API.

description: Option<String>

A description of the API. CommonMark syntax may be used.

terms_of_service: Option<String>

A URI for the Terms of Service for the API.

contact: Option<Contact>

Contact information for the exposed API.

license: Option<License>

License information for the exposed API.

version: String

The version of this API document.

This is not the OpenAPI specification version — that lives on Document::openapi — nor is it required to be the implementation’s version.

extensions: Extensions

Specification extensions.

Implementations

impl Info

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

Creates the required fields of an Info Object.

pub fn with_summary(self, summary: impl Into<String>) -> Self

Sets the short summary.

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

Sets the description.

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

Sets the contact information.

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

Sets the license.

Trait Implementations

impl Clone for Info

fn clone(&self) -> Self

Returns a duplicate 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() -> Self

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 Eq for Info

impl PartialEq for Info

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

Equality operator ==.

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

Inequality operator !=.

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 StructuralPartialEq for Info