Struct Options 

pub struct Options {
    pub title: String,
    pub version: String,
    pub description: Option<String>,
    pub servers: Vec<ServerInfo>,
}

Top-level options for the generated spec. The OpenAPI info object plus an optional servers list.

Fields

title: String

The API title (OpenAPI info.title).

version: String

The API version (OpenAPI info.version).

description: Option<String>

An optional API description (OpenAPI info.description).

servers: Vec<ServerInfo>

The base URLs the API is served at (OpenAPI servers).

Implementations

impl Options

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

New Options with the given info.title and info.version. Both are required by the OpenAPI 3.1 spec.

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

Set info.description.

pub fn server( self, url: impl Into<String>, description: Option<impl Into<String>>, ) -> Self

Add an entry to the servers array.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.