Struct rocket_okapi::rapidoc::RapiDocConfig

pub struct RapiDocConfig {
    pub title: Option<String>,
    pub general: GeneralConfig,
    pub ui: UiConfig,
    pub nav: NavConfig,
    pub layout: LayoutConfig,
    pub hide_show: HideShowConfig,
    pub api: ApiConfig,
    pub slots: SlotsConfig,
    pub custom_html: Option<String>,
    pub custom_template_tags: HashMap<String, String>,
}

A struct containing information about where and how the openapi.json files are served.

Fields

title: Option<String>

Webpage title. An optional title for the webpage. If set to None we will create a default title.

general: GeneralConfig

General settings. The spec_urls property must be specified by the user.

ui: UiConfig

Settings related to the ui and theming.

nav: NavConfig

Settings related to the nav bar.

layout: LayoutConfig

Settings relatd to the layout of the displayed docs.

hide_show: HideShowConfig

Settings used to control what features should or should not be displayed.

api: ApiConfig

Settings used to configure access to the api.

slots: SlotsConfig

Settings to configure the Rapi Doc “slots”.

custom_html: Option<String>

Provide a custom HTML file content. The templated values will still be replaced. So other settings can still be used. Use ../rapidoc/index.html as an example.

custom_template_tags: HashMap<String, String>

A list of custom tags that can be used in combination with custom_html. This allows for additional custom template tags that will be replaced in the html. The key should be the name of the tag without the brackets, {{key}}. The value will be the text the value will be replaced with.

The custom tags are replaced before all other tags, this allows for more flexibility but also means that you can break things. If you want to be sure to not overlap with existing tags, prefix your custom tags with _, c_ or C_. We will never use these prefixes in the provided tags.

Trait Implementations

impl Clone for RapiDocConfig

fn clone(&self) -> RapiDocConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RapiDocConfig

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

Formats the value using the given formatter.

impl Default for RapiDocConfig

fn default() -> RapiDocConfig

Returns the “default value” for a type.