Struct rocket_okapi::rapidoc::GeneralConfig

pub struct GeneralConfig {
    pub spec_urls: Vec<UrlObject>,
    pub sort_tags: bool,
    pub sort_endpoints_by: SortEndpointsBy,
    pub heading_text: String,
    pub goto_path: String,
    pub fill_request_fields_with_example: bool,
}

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

Fields

spec_urls: Vec<UrlObject>

Urls of the OpenAPI spec to view.

This field must be manually filled with at least one element. More then one element is currently not supported yet, but can be used with custom HTML.

sort_tags: bool

To list tags in alphabetic order, otherwise tags will be ordered based on how it is specified under the tags section in the spec.

The default is false.

sort_endpoints_by: SortEndpointsBy

Sort endpoints within each tags by path or method.

The default is SortEndpointsBy::Path.

heading_text: String

Heading Text on top-left corner.

goto_path: String

Initial location on the document(identified by method and path) where you want to go after the spec is loaded. goto_path should be in the form of {method}-{path}. For instance you want to scrollTo “GET /user/login” you should provide the location as get-/user/login.

fill_request_fields_with_example: bool

Request fields will be filled with example value (if provided in spec).

The default is true.

Trait Implementations

impl Clone for GeneralConfig

fn clone(&self) -> GeneralConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GeneralConfig

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

Formats the value using the given formatter.

impl Default for GeneralConfig

fn default() -> Self

Returns the “default value” for a type.