Struct DocsConfig 

pub struct DocsConfig {
    pub docs_path: Option<String>,
    pub redoc_path: Option<String>,
    pub openapi_path: String,
    pub title: String,
    pub swagger_ui_parameters: Option<String>,
    pub swagger_ui_init_oauth: Option<String>,
    pub favicon_url: Option<String>,
    pub swagger_cdn_url: String,
    pub redoc_cdn_url: String,
}

Configuration for the API documentation endpoints.

Fields

docs_path: Option<String>

Path for Swagger UI. Set to None to disable.

redoc_path: Option<String>

Path for ReDoc. Set to None to disable.

openapi_path: String

Path for the OpenAPI JSON specification.

title: String

Title shown in the documentation.

swagger_ui_parameters: Option<String>

Swagger UI configuration parameters (JSON).

swagger_ui_init_oauth: Option<String>

Swagger UI OAuth initialization config (JSON).

favicon_url: Option<String>

Custom favicon URL.

swagger_cdn_url: String

CDN base URL for Swagger UI assets.

redoc_cdn_url: String

CDN base URL for ReDoc assets.

Implementations

impl DocsConfig

pub fn new() -> Self

Create a new DocsConfig with default settings.

pub fn docs_path(self, path: impl Into<Option<String>>) -> Self

Set the path for Swagger UI. Use None to disable.

pub fn redoc_path(self, path: impl Into<Option<String>>) -> Self

Set the path for ReDoc. Use None to disable.

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

Set the path for the OpenAPI JSON specification.

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

Set the title shown in documentation.

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

Set Swagger UI configuration parameters (JSON object).

Example

config.swagger_ui_parameters(r#"{"docExpansion": "none", "filter": true}"#)

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

Set Swagger UI OAuth initialization config (JSON object).

Example

config.swagger_ui_init_oauth(r#"{"clientId": "my-client-id"}"#)

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

Set a custom favicon URL.

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

Set the CDN base URL for Swagger UI assets.

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

Set the CDN base URL for ReDoc assets.

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

Formats the value using the given formatter.

impl Default for DocsConfig

fn default() -> Self

Returns the “default value” for a type.