Struct rocket_okapi::rapidoc::SlotsConfig

pub struct SlotsConfig {
    pub default: Vec<String>,
    pub logo: Option<String>,
    pub header: Option<String>,
    pub footer: Option<String>,
    pub nav_logo: Option<String>,
    pub overview: Option<String>,
    pub servers: Option<String>,
    pub auth: Option<String>,
    pub tags: HashMap<String, String>,
    pub endpoints: HashMap<String, String>,
}

Config used to configure the slots. Each slot usually corresponds with one section. Each field can include any HTML tags.

For an example of all the slots locations see: https://mrin9.github.io/RapiDoc/examples/slots.html

Fields

default: Vec<String>

Any content here will be shown immediately under the header and above the info section.

logo: Option<String>

An image used as the page logo. This can contain:

• An URL to an image (eg: "https://example.com/example.png")
• An encoded image (eg: "data:image/svg+xml;base64,...==")

header: Option<String>

The contents appear at the header after the spec-url input.

footer: Option<String>

The contents appear at the bottom of the spec.

nav_logo: Option<String>

The contents appear at side navigation bar (only available in read-mode).

overview: Option<String>

The contents appear at overview section.

servers: Option<String>

The contents appear at server section.

auth: Option<String>

The contents appear at authentication section.

tags: HashMap<String, String>

Each tag is identified by a name, this slot can be used to insert HTML content under various tags.

The first value (key) should be the name of the tag. This will be prefixed with tag--{tag-name} when generated. The second value (value) will be the HTML inserted.

endpoints: HashMap<String, String>

Each path is identified by an id. The key of which is in the format of {method}-{path}. and certain invalid characters such as {, }, #, space is replaced by hyphen (-). Use this slot to insert HTML content into a specific tag.

Trait Implementations

impl Clone for SlotsConfig

fn clone(&self) -> SlotsConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SlotsConfig

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

Formats the value using the given formatter.

impl Default for SlotsConfig

fn default() -> SlotsConfig

Returns the “default value” for a type.