Struct DocsConfig 

pub struct DocsConfig {
    pub path: String,
    pub title: String,
    pub version: String,
    pub description: Option<String>,
}

Documentation configuration

Configures how API documentation should be served.

Fields

path: String

Path where documentation will be served (e.g., “/docs”)

title: String

API title

version: String

API version

description: Option<String>

Optional API description

Implementations

impl DocsConfig

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

Create a new documentation configuration

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

Set the API description

pub fn openapi_path(&self) -> String

Get the OpenAPI spec path

Trait Implementations

impl Clone for DocsConfig

fn clone(&self) -> DocsConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocsConfig

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

Formats the value using the given formatter.