Struct OpenApiConfig 

pub struct OpenApiConfig {
    pub title: String,
    pub version: String,
    pub description: Option<String>,
    pub json_path: String,
    pub docs_path: String,
}

Configuration for OpenAPI documentation

Fields

title: String

API title

version: String

API version

description: Option<String>

API description

json_path: String

Path to serve OpenAPI JSON

docs_path: String

Path to serve Swagger UI

Implementations

impl OpenApiConfig

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

Create a new OpenAPI configuration

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

Set API description

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

Set path for OpenAPI JSON endpoint

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

Set path for Swagger UI docs

Trait Implementations

impl Clone for OpenApiConfig

fn clone(&self) -> OpenApiConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiConfig

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

Formats the value using the given formatter.

impl Default for OpenApiConfig

fn default() -> Self

Returns the “default value” for a type.