Struct OpenApiSettings 

pub struct OpenApiSettings {
    pub enabled: bool,
    pub path: String,
    pub title: String,
    pub version: String,
    pub server: Option<String>,
}

What the configuration says about the OpenAPI document.

Fields

enabled: bool

Whether to serve it.

path: String

Where.

title: String

The document’s title.

version: String

The API’s version.

server: Option<String>

The base URL to advertise, if any.

Implementations

impl OpenApiSettings

pub fn from_config(config: &Config) -> Self

Read them from config.

pub fn apply(&self, document: OpenApi) -> OpenApi

Apply the configured title, version and server to document.

The application declares the endpoints; the configuration decides what the document calls itself, because a title and a version are deployment facts rather than code.

pub fn render( &self, document: OpenApi, router: &CompiledRouter, ) -> Option<Arc<Rendered>>

Render it against router, or None when it is off.

Trait Implementations

impl Clone for OpenApiSettings

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 OpenApiSettings

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

Formats the value using the given formatter.

impl Eq for OpenApiSettings

impl PartialEq for OpenApiSettings

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OpenApiSettings