Struct utoipa::openapi::info::InfoBuilder

pub struct InfoBuilder { /* private fields */ }

Builder for Info with chainable configuration methods to create a new Info.

Examples

Create Info using InfoBuilder.

let info = InfoBuilder::new()
     .title("My api")
     .version("1.0.0")
     .contact(Some(ContactBuilder::new()
          .name(Some("Admin Admin"))
          .email(Some("amdin@petapi.com"))
          .build()
      ))
     .build();

Implementations

impl InfoBuilder

pub fn new() -> InfoBuilder

Constructs a new InfoBuilder.

pub fn build(self) -> Info

Constructs a new Info taking all fields values from this object.

impl InfoBuilder

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: Option<S>) -> Self

Add description of the API.

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

Add url for terms of the API.

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

Add contact information of the API.

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

Add licence of the API.

Trait Implementations

impl Default for InfoBuilder

fn default() -> Self

Returns the “default value” for a type.

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.